Skip to content
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 46 commits into from Jul 8, 2022

Commits on Jun 30, 2022

  1. Copy the full SHA
    46073dd View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    f0fa4b5 View commit details
    Browse the repository at this point in the history
  3. Copy the full SHA
    a889e3a View commit details
    Browse the repository at this point in the history
  4. Copy the full SHA
    5de8b9a View commit details
    Browse the repository at this point in the history
  5. 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
    hasezoey committed Jun 30, 2022
    Copy the full SHA
    aa297ba View commit details
    Browse the repository at this point in the history
  6. 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
    hasezoey committed Jun 30, 2022
    Copy the full SHA
    b4c26a4 View commit details
    Browse the repository at this point in the history
  7. Copy the full SHA
    c42bdba View commit details
    Browse the repository at this point in the history
  8. Copy the full SHA
    dce32d5 View commit details
    Browse the repository at this point in the history
  9. style: remove function definition from "VirtualType.get" and "Virtual…

    …Type.set"
    
    This is because dox (jsdoctypeparser@1.2.0) does not seem to recognize "@callback" or "@typedef" with "@name"
    hasezoey committed Jun 30, 2022
    Copy the full SHA
    7155089 View commit details
    Browse the repository at this point in the history
  10. Copy the full SHA
    c22e7cf View commit details
    Browse the repository at this point in the history
  11. Copy the full SHA
    97b47c3 View commit details
    Browse the repository at this point in the history
  12. Copy the full SHA
    a6c9834 View commit details
    Browse the repository at this point in the history
  13. style: change jsdoc tag "memberOf" to point to the correct member for…

    … "QueryCursor.prototype[Symbol.asyncIterator]"
    hasezoey committed Jun 30, 2022
    Copy the full SHA
    0354bb5 View commit details
    Browse the repository at this point in the history
  14. Copy the full SHA
    48beee1 View commit details
    Browse the repository at this point in the history
  15. Copy the full SHA
    7646125 View commit details
    Browse the repository at this point in the history
  16. Copy the full SHA
    82a8c03 View commit details
    Browse the repository at this point in the history
  17. 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"
    hasezoey committed Jun 30, 2022
    Copy the full SHA
    cb8e66a View commit details
    Browse the repository at this point in the history
  18. Copy the full SHA
    953853f View commit details
    Browse the repository at this point in the history
  19. style: remove "- " before description to be more consistent

    This also sometimes somehow messes-up the documentation styling
    hasezoey committed Jun 30, 2022
    Copy the full SHA
    e57594c View commit details
    Browse the repository at this point in the history
  20. 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
    hasezoey committed Jun 30, 2022
    Copy the full SHA
    1719bf6 View commit details
    Browse the repository at this point in the history
  21. 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"
    hasezoey committed Jun 30, 2022
    Copy the full SHA
    590f0ff View commit details
    Browse the repository at this point in the history
  22. Copy the full SHA
    dbc078b View commit details
    Browse the repository at this point in the history
  23. Copy the full SHA
    728d967 View commit details
    Browse the repository at this point in the history
  24. Copy the full SHA
    96e1ffd View commit details
    Browse the repository at this point in the history
  25. 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
    hasezoey committed Jun 30, 2022
    Copy the full SHA
    cfe7248 View commit details
    Browse the repository at this point in the history
  26. Copy the full SHA
    39a02a1 View commit details
    Browse the repository at this point in the history

Commits on Jul 2, 2022

  1. Copy the full SHA
    bb0bf63 View commit details
    Browse the repository at this point in the history
  2. style: update "syncIndexes" jsdoc to only have "Promise" as return ty…

    …pe for "connection" and "mongoose"
    hasezoey committed Jul 2, 2022
    Copy the full SHA
    407fe61 View commit details
    Browse the repository at this point in the history

Commits on Jul 3, 2022

  1. Copy the full SHA
    831d170 View commit details
    Browse the repository at this point in the history
  2. chore(docs/source/api): basic handle jsdoc "@instance" tag

    also warn if both a static and instance are found
    hasezoey committed Jul 3, 2022
    Copy the full SHA
    1384f27 View commit details
    Browse the repository at this point in the history
  3. Copy the full SHA
    a006214 View commit details
    Browse the repository at this point in the history
  4. 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")
    hasezoey committed Jul 3, 2022
    Copy the full SHA
    17c7e63 View commit details
    Browse the repository at this point in the history
  5. style: update jsdoc "memberOf" for "MongooseMap.prototype.$isMongoose…

    …Map" to reflect actual name
    hasezoey committed Jul 3, 2022
    Copy the full SHA
    73f3400 View commit details
    Browse the repository at this point in the history
  6. Copy the full SHA
    6c0e316 View commit details
    Browse the repository at this point in the history
  7. Copy the full SHA
    da57bf2 View commit details
    Browse the repository at this point in the history
  8. Copy the full SHA
    9f73623 View commit details
    Browse the repository at this point in the history
  9. chore(docs/source/api): add "void" to types in return, so it does not…

    … result in a empty field
    hasezoey committed Jul 3, 2022
    Copy the full SHA
    fcb2bfc View commit details
    Browse the repository at this point in the history
  10. 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
    hasezoey committed Jul 3, 2022
    Copy the full SHA
    cf6ad88 View commit details
    Browse the repository at this point in the history
  11. 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
    hasezoey committed Jul 3, 2022
    Copy the full SHA
    ec947f6 View commit details
    Browse the repository at this point in the history

Commits on Jul 4, 2022

  1. Copy the full SHA
    5d80579 View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    906cb4f View commit details
    Browse the repository at this point in the history
  3. Copy the full SHA
    e6776b3 View commit details
    Browse the repository at this point in the history
  4. Copy the full SHA
    a1eade6 View commit details
    Browse the repository at this point in the history
  5. 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
    hasezoey committed Jul 4, 2022
    Copy the full SHA
    4c7e85c View commit details
    Browse the repository at this point in the history
  6. 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
    hasezoey committed Jul 4, 2022
    Copy the full SHA
    6a10d4f View commit details
    Browse the repository at this point in the history

Commits on Jul 8, 2022

  1. Copy the full SHA
    1cc2293 View commit details
    Browse the repository at this point in the history