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
Commits on Jun 30, 2022
-
-
-
-
style: fix empty "returns" jsdoc for "syncIndexes"
This change is required because since dox 0.5.0 a error will be thrown if "return" present but empty This change also extends the message to say what gets returned
-
style: fix empty "returns" jsdoc for "buildBulkWriteOperations"
This change is required because since dox 0.5.0 a error will be thrown if "return" present but empty This change also extends the message to say what gets returned
-
-
-
style: remove function definition from "VirtualType.get" and "Virtual…
-
style: change jsdoc tag "memberOf" to point to the correct member for…
… "QueryCursor.prototype[Symbol.asyncIterator]"
-
style: move jsdoc comment to proper function ("DocumentArrayPath.set")
This also changes the description for the parameters to match "SchemaType.set" and not cause bad formatting Also upates the return type to "void"
-
style: remove "- " before description to be more consistent
This also sometimes somehow messes-up the documentation styling
-
style: remove extra parameters from "@static"
The things that were defined there are set via other things anyway, and many did not even have it set
-
style: move jsdoc comment to proper function ("SubdocumentPath.set")
This also changes the description for the parameters to match "SubdocumentPath.set" and not cause bad formatting Also upates the return type to "void"
-
-
-
chore(docs/source/api): use "ctx.constructor" over "data.name" for "f…
…unction" and "static" This fixes static "Schematype" properties to be in a different case than instance properties
-
Commits on Jul 2, 2022
-
-
style: update "syncIndexes" jsdoc to only have "Promise" as return ty…
…pe for "connection" and "mongoose"
Commits on Jul 3, 2022
-
-
chore(docs/source/api): basic handle jsdoc "@instance" tag
also warn if both a static and instance are found
-
chore(docs/source/api): move setting of "ctx.string" to after the tag…
…s loop This will make setting "ctx.string" consistently and should make it independent of tag order (Also thanks to the previous commit warns against both "instance" and "static")
-
style: update jsdoc "memberOf" for "MongooseMap.prototype.$isMongoose…
…Map" to reflect actual name
-
style: set proper jsdoc "memberOf" path for "MongooseBuffer.mixin.*" …
…and add "@static"
-
chore(docs/source/api): remove redundant setting of "isFunction" in "…
…memberOf" handling
-
chore(docs/source/api): add "void" to types in return, so it does not…
… result in a empty field
-
chore(docs/source/api): add some jsdoc-typescript types to help remem…
…ber all values This makes use of https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html and is still fully compatible with plain js
-
chore(docs/source/api): add handling for "@deprecated" and property
This currently does not add anything to the final documentation, because i dont know which style it should be
Commits on Jul 4, 2022
-
-
chore(docs/source/api): change "return" to overwrite "description" in…
…stead of adding to "return" This is changed because "return" property was never used, but the "description" was (in pug files) but i am not familiar with pug to change that Also updates the second "replace" call because "\n" is mostly added to the end which makes it ineffective
-
style: add ":" to all jsdoc headers where missing
This is to change the style to be consistent and headers with ":" seem to be the most used, so it was changed to that