Change Comments from /*! to /** to make possible jsdoc available
#12337
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 makes the all description and types available via jsdoc, but still excluded from the documentation
hasezoey
commented
Aug 30, 2022
|
Also, I'm sorry but it looks like I broke tests by resolving merge conflict. Any ideas on how to fix @hasezoey ? |
i still have it locally, i will force-push a fix |
hasezoey
force-pushed
the
changeCommentType
branch
from
5cdc9ef
to
3aa2411
Compare
|
fixed with proper merge |
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.
Summary
This PR changes most
/*!to/**to make jsdoc available for those that have descriptions / tags defined, also does:* ignore@ignoretoignore/*!to///*!before)@privateto@api privateapi publictoapi privateforconst mongoose = module.exports = exports = new Mongoose({, because this had no effect anyway (from what i could tell)Model.prototype.$removeis now public in the documentationModel.db;now properly appears as a static property in the documentationArraySubdocument.prototype.$parentis nowapi public(because other aliases are)@apitags from jsdoc intest/*filesThings that were ignored:
ignoremodule exportsinherits from(assigning.prototype/._proto_)