Dart: use bullet points to document parameters in comments#1765
Merged
Conversation
The additional whitespaces caused problems for DartDoc. The rendered comments were invalid -- parameters were not properly listed. This commit removes redundant whitespaces and aligns the behavior with rendering of function comments. Signed-off-by: Patryk Wrobel <183546751+pwrobeldev@users.noreply.github.com>
DartDoc uses markdown. The bullet points should be used for describing parameters of constructors and functions. Signed-off-by: Patryk Wrobel <183546751+pwrobeldev@users.noreply.github.com>
DartDoc uses markdown. The bullet points should be used for describing parameters of constructors and functions. Signed-off-by: Patryk Wrobel <183546751+pwrobeldev@users.noreply.github.com>
DartDoc uses markdown. The bullet points should be used for describing parameters of constructors and functions. Signed-off-by: Patryk Wrobel <183546751+pwrobeldev@users.noreply.github.com>
DartDoc uses markdown. The bullet points should be used for describing parameters of constructors and functions. Signed-off-by: Patryk Wrobel <183546751+pwrobeldev@users.noreply.github.com>
Signed-off-by: Patryk Wrobel <183546751+pwrobeldev@users.noreply.github.com>
Hsilgos
approved these changes
Jun 12, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The rendered comments for constructors of structures contained
redundant white-spaces. Because of that DartDoc was not able to
render the description of parameters properly.
Moreover, the generated description of parameters did not contain
bullet points -- they were only separated with new lines.
This change:
readability