New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update dox
to latest version and fix some documentation issues
#12024
Merged
Merged
Changes from 45 commits
Commits
Show all changes
46 commits
Select commit
Hold shift + click to select a range
46073dd
chore: add yarn.lock to ignore
hasezoey f0fa4b5
chore: upgrade "dox" to "0.4.4"
hasezoey a889e3a
chore: upgrade "dox" to "0.4.5"
hasezoey 5de8b9a
chore(docs/source/api.js): add log of file when "parseComments" errors
hasezoey aa297ba
style: fix empty "returns" jsdoc for "syncIndexes"
hasezoey b4c26a4
style: fix empty "returns" jsdoc for "buildBulkWriteOperations"
hasezoey c42bdba
chore: upgrade "dox" to "0.5.3"
hasezoey dce32d5
style: properly define Document Arrays in jsdoc
hasezoey 7155089
style: remove function definition from "VirtualType.get" and "Virtual…
hasezoey c22e7cf
style: add jsdoc tags "memberOf" and "instance" to "Mongoose.prototyp…
hasezoey 97b47c3
style: add jsdoc tag "memberOf" to "Model.prototype.increment"
hasezoey a6c9834
style: add jsdoc tag "memberOf" to "QueryCursor.prototype.map"
hasezoey 0354bb5
style: change jsdoc tag "memberOf" to point to the correct member for…
hasezoey 48beee1
style: add jsdoc tag "memberOf" to "AggregationCursor.prototype.map"
hasezoey 7646125
style: properly set jsdoc tag "function" for "SchemaType.prototype.ca…
hasezoey 82a8c03
style: remove and add some jsdoc tags for "SchemaType.prototype.castF…
hasezoey cb8e66a
style: move jsdoc comment to proper function ("DocumentArrayPath.set")
hasezoey 953853f
style: replace all "@param {*}" with "@param {Any}" to match other cases
hasezoey e57594c
style: remove "- " before description to be more consistent
hasezoey 1719bf6
style: remove extra parameters from "@static"
hasezoey 590f0ff
style: move jsdoc comment to proper function ("SubdocumentPath.set")
hasezoey dbc078b
chore: upgrade "dox" to "0.8.1"
hasezoey 728d967
chore: upgrade "dox" to "0.9.1"
hasezoey 96e1ffd
chore(docs/source/api): change to use "isFunction" instead of directl…
hasezoey cfe7248
chore(docs/source/api): use "ctx.constructor" over "data.name" for "f…
hasezoey 39a02a1
chore(docs/source/api): remove console.log of the "ctx"
hasezoey bb0bf63
Merge branch 'master' into updateDox
Uzlopak 407fe61
style: update "syncIndexes" jsdoc to only have "Promise" as return ty…
hasezoey 831d170
Merge branch 'master' into updateDox
hasezoey 1384f27
chore(docs/source/api): basic handle jsdoc "@instance" tag
hasezoey a006214
chore(docs/source/api): rename "ctx.static" to "ctx.isStatic"
hasezoey 17c7e63
chore(docs/source/api): move setting of "ctx.string" to after the tag…
hasezoey 73f3400
style: update jsdoc "memberOf" for "MongooseMap.prototype.$isMongoose…
hasezoey 6c0e316
style: set proper jsdoc "memberOf" path for "MongooseBuffer.mixin.*" …
hasezoey da57bf2
chore(docs/source/api): remove redundant setting of "isFunction" in "…
hasezoey 9f73623
chore(docs/source/api): add more comments explaining what some things do
hasezoey fcb2bfc
chore(docs/source/api): add "void" to types in return, so it does not…
hasezoey cf6ad88
chore(docs/source/api): add some jsdoc-typescript types to help remem…
hasezoey ec947f6
chore(docs/source/api): add handling for "@deprecated" and property
hasezoey 5d80579
style: properly escape "@type" type parameters
hasezoey 906cb4f
style: fix missing next line in jsdoc for "Aggregate.prototype.lookup"
hasezoey e6776b3
chore(docs/source/api): re-add "null" to types when nullable
hasezoey a1eade6
style: update "Query.prototype.box" jsdoc to use proper "@param" tags
hasezoey 4c7e85c
chore(docs/source/api): change "return" to overwrite "description" in…
hasezoey 6a10d4f
style: add ":" to all jsdoc headers where missing
hasezoey 1cc2293
Merge branch 'master' into updateDox
vkarpov15 File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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 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 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 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 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 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i have now included basic handling for
@deprecated
tag, but i am not sure where or in what style it should appear in the documentation