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
-
Configuration menu - View commit details
-
Copy full SHA for 46073dd - Browse repository at this point
Copy the full SHA 46073ddView commit details -
Configuration menu - View commit details
-
Copy full SHA for f0fa4b5 - Browse repository at this point
Copy the full SHA f0fa4b5View commit details -
Configuration menu - View commit details
-
Copy full SHA for a889e3a - Browse repository at this point
Copy the full SHA a889e3aView commit details -
Configuration menu - View commit details
-
Copy full SHA for 5de8b9a - Browse repository at this point
Copy the full SHA 5de8b9aView commit details -
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
Configuration menu - View commit details
-
Copy full SHA for aa297ba - Browse repository at this point
Copy the full SHA aa297baView commit details -
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
Configuration menu - View commit details
-
Copy full SHA for b4c26a4 - Browse repository at this point
Copy the full SHA b4c26a4View commit details -
Configuration menu - View commit details
-
Copy full SHA for c42bdba - Browse repository at this point
Copy the full SHA c42bdbaView commit details -
Configuration menu - View commit details
-
Copy full SHA for dce32d5 - Browse repository at this point
Copy the full SHA dce32d5View commit details -
style: remove function definition from "VirtualType.get" and "Virtual…
Configuration menu - View commit details
-
Copy full SHA for 7155089 - Browse repository at this point
Copy the full SHA 7155089View commit details -
Configuration menu - View commit details
-
Copy full SHA for c22e7cf - Browse repository at this point
Copy the full SHA c22e7cfView commit details -
Configuration menu - View commit details
-
Copy full SHA for 97b47c3 - Browse repository at this point
Copy the full SHA 97b47c3View commit details -
Configuration menu - View commit details
-
Copy full SHA for a6c9834 - Browse repository at this point
Copy the full SHA a6c9834View commit details -
style: change jsdoc tag "memberOf" to point to the correct member for…
… "QueryCursor.prototype[Symbol.asyncIterator]"
Configuration menu - View commit details
-
Copy full SHA for 0354bb5 - Browse repository at this point
Copy the full SHA 0354bb5View commit details -
Configuration menu - View commit details
-
Copy full SHA for 48beee1 - Browse repository at this point
Copy the full SHA 48beee1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7646125 - Browse repository at this point
Copy the full SHA 7646125View commit details -
Configuration menu - View commit details
-
Copy full SHA for 82a8c03 - Browse repository at this point
Copy the full SHA 82a8c03View commit details -
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"
Configuration menu - View commit details
-
Copy full SHA for cb8e66a - Browse repository at this point
Copy the full SHA cb8e66aView commit details -
Configuration menu - View commit details
-
Copy full SHA for 953853f - Browse repository at this point
Copy the full SHA 953853fView commit details -
style: remove "- " before description to be more consistent
This also sometimes somehow messes-up the documentation styling
Configuration menu - View commit details
-
Copy full SHA for e57594c - Browse repository at this point
Copy the full SHA e57594cView commit details -
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
Configuration menu - View commit details
-
Copy full SHA for 1719bf6 - Browse repository at this point
Copy the full SHA 1719bf6View commit details -
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"
Configuration menu - View commit details
-
Copy full SHA for 590f0ff - Browse repository at this point
Copy the full SHA 590f0ffView commit details -
Configuration menu - View commit details
-
Copy full SHA for dbc078b - Browse repository at this point
Copy the full SHA dbc078bView commit details -
Configuration menu - View commit details
-
Copy full SHA for 728d967 - Browse repository at this point
Copy the full SHA 728d967View commit details -
Configuration menu - View commit details
-
Copy full SHA for 96e1ffd - Browse repository at this point
Copy the full SHA 96e1ffdView commit details -
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
Configuration menu - View commit details
-
Copy full SHA for cfe7248 - Browse repository at this point
Copy the full SHA cfe7248View commit details -
Configuration menu - View commit details
-
Copy full SHA for 39a02a1 - Browse repository at this point
Copy the full SHA 39a02a1View commit details
Commits on Jul 2, 2022
-
Configuration menu - View commit details
-
Copy full SHA for bb0bf63 - Browse repository at this point
Copy the full SHA bb0bf63View commit details -
style: update "syncIndexes" jsdoc to only have "Promise" as return ty…
…pe for "connection" and "mongoose"
Configuration menu - View commit details
-
Copy full SHA for 407fe61 - Browse repository at this point
Copy the full SHA 407fe61View commit details
Commits on Jul 3, 2022
-
Configuration menu - View commit details
-
Copy full SHA for 831d170 - Browse repository at this point
Copy the full SHA 831d170View commit details -
chore(docs/source/api): basic handle jsdoc "@instance" tag
also warn if both a static and instance are found
Configuration menu - View commit details
-
Copy full SHA for 1384f27 - Browse repository at this point
Copy the full SHA 1384f27View commit details -
Configuration menu - View commit details
-
Copy full SHA for a006214 - Browse repository at this point
Copy the full SHA a006214View commit details -
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")
Configuration menu - View commit details
-
Copy full SHA for 17c7e63 - Browse repository at this point
Copy the full SHA 17c7e63View commit details -
style: update jsdoc "memberOf" for "MongooseMap.prototype.$isMongoose…
…Map" to reflect actual name
Configuration menu - View commit details
-
Copy full SHA for 73f3400 - Browse repository at this point
Copy the full SHA 73f3400View commit details -
style: set proper jsdoc "memberOf" path for "MongooseBuffer.mixin.*" …
…and add "@static"
Configuration menu - View commit details
-
Copy full SHA for 6c0e316 - Browse repository at this point
Copy the full SHA 6c0e316View commit details -
chore(docs/source/api): remove redundant setting of "isFunction" in "…
…memberOf" handling
Configuration menu - View commit details
-
Copy full SHA for da57bf2 - Browse repository at this point
Copy the full SHA da57bf2View commit details -
Configuration menu - View commit details
-
Copy full SHA for 9f73623 - Browse repository at this point
Copy the full SHA 9f73623View commit details -
chore(docs/source/api): add "void" to types in return, so it does not…
… result in a empty field
Configuration menu - View commit details
-
Copy full SHA for fcb2bfc - Browse repository at this point
Copy the full SHA fcb2bfcView commit details -
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
Configuration menu - View commit details
-
Copy full SHA for cf6ad88 - Browse repository at this point
Copy the full SHA cf6ad88View commit details -
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
Configuration menu - View commit details
-
Copy full SHA for ec947f6 - Browse repository at this point
Copy the full SHA ec947f6View commit details
Commits on Jul 4, 2022
-
Configuration menu - View commit details
-
Copy full SHA for 5d80579 - Browse repository at this point
Copy the full SHA 5d80579View commit details -
Configuration menu - View commit details
-
Copy full SHA for 906cb4f - Browse repository at this point
Copy the full SHA 906cb4fView commit details -
Configuration menu - View commit details
-
Copy full SHA for e6776b3 - Browse repository at this point
Copy the full SHA e6776b3View commit details -
Configuration menu - View commit details
-
Copy full SHA for a1eade6 - Browse repository at this point
Copy the full SHA a1eade6View commit details -
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
Configuration menu - View commit details
-
Copy full SHA for 4c7e85c - Browse repository at this point
Copy the full SHA 4c7e85cView commit details -
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
Configuration menu - View commit details
-
Copy full SHA for 6a10d4f - Browse repository at this point
Copy the full SHA 6a10d4fView commit details
Commits on Jul 8, 2022
-
Configuration menu - View commit details
-
Copy full SHA for 1cc2293 - Browse repository at this point
Copy the full SHA 1cc2293View commit details