Allow @param and @return descriptions to be preceded by a newline. #227
Conversation
This file contains 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
This fixes two bugs that broke the @param and @return descriptions for comments formatted like this (with a newline before the descriptions): /** Main description. @method foo @param {String} bar This is the bar param. @param {String} baz This is the baz param. @return {Boolean} Whether or not bar and baz got fooed. **/
caridy
added a commit
that referenced
this pull request
Apr 22, 2014
caridy
added a commit
that referenced
this pull request
Apr 22, 2014
caridy
added a commit
that referenced
this pull request
Apr 22, 2014
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This fixes two bugs triggered by putting a newline before the description of a
@paramor@returntag. It was cramping my style, since I find this to be a more readable comment format:Specifically, the parameter names in this case ended up as "bar!
YUIDOC_LINE!" and "baz!YUIDOC_LINE!" instead of "bar" and "baz", and the return description was treated as a code block by the Markdown parser due to its indentation (whereas the precedent elsewhere in YUIDoc is to normalize indentation to the first line of a description).