jsdoc comments #836
Merged
jsdoc comments #836
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
|
Such docs. Very commented. Well done. 👍 |
| * @param {Object} options contains the parameters: | ||
| * @public | ||
| * @class | ||
| * @param {Object} opts contains the parameters: | ||
| * - {Object} stream The stream to which to write when dumping captured |
There was a problem hiding this comment.
Is this the blessed way to doc a complex object? I had thought it was something like
/**
* @param {Object} opts
* @param {Object} opts.someotherobject
* @param {String} opts.someString
*/
There was a problem hiding this comment.
Per the JSDoc docs:
If a parameter is expected to have a specific property, you can document that property by providing an additional @param tag.
So it should probably be documented as @yunong proposed.
There was a problem hiding this comment.
Good catch, that was an existing comment block, so I didn't look too closely. I'll fix it up as proposed.
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.
No description provided.