doc(extend/console): add jsdoc #4500
Merged
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
SukkaW
requested review from
himself65,
stevenjoezhang,
curbengh,
segayuu and
yoshinorin
himself65
previously approved these changes
Aug 27, 2020
SukkaW
force-pushed
the
jsdoc-type-extend-console
branch
from
31928fd
to
39e9779
Compare
curbengh
reviewed
Aug 29, 2020
lib/extend/console.js
Outdated
| * @param {String} name - The name of console plugin to be registered | ||
| * @param {String} desc - More detailed information about a console command | ||
| * @param {Option} options - The description of each option of a console command. | ||
| * @param {Function} fn |
There was a problem hiding this comment.
"The console plugin to be registered" ?
stevenjoezhang
approved these changes
Mar 26, 2021
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.
What does it do?
#4136
Before we migrate Hexo to typescript, we could first bring up JSDoc. It will not only help the migration later but also provides the autocompletion for those plugin developers.
cc @septs
How to test
Screenshots
Pull request tasks