Instruction file imported from casual-simulation/casualos (.github/instructions/documentation.instructions.md). Copyright stays with the author.

JSDoc comments

• Use JSDoc comments to document functions, classes, and interfaces.
• Use @param to document function parameters.
• Use @returns to document function return values.
• (Required) Use @dochash to specify the page that the documentation should be generated into.
  • The following hashes are available:
    • actions/ai
    • actions/bot-filters
    • actions/bytes
    • actions/crypto
    • actions/data
    • actions/debuggers
    • actions/experimental
    • actions/loom
    • actions/math
    • actions/mods
    • actions/os/animations
    • actions/os/app
    • actions/os/audio
    • actions/os/barcodes
    • actions/os/camera
    • actions/os/clipboard
    • actions/os/event
    • actions/os/files
    • actions/os/geolocation
    • actions/os/image-classification
    • actions/os/input
    • actions/os/ldraw
    • actions/os/media
    • actions/os/moderation
    • actions/os/portals
    • actions/os/spaces
    • actions/os/system
    • actions/os/records
    • actions/os/remotes
    • actions/os/rooms
    • actions/os/time
    • actions/os/xr
    • actions/web
    • types/ai
    • types/core
    • types/debuggers/common
    • types/debuggers/debugger
    • types/debuggers/pausable-debugger
    • types/error
    • types/experimental
    • types/math/vectors
    • types/math/rotations
    • types/os/animations
    • types/os/audio
    • types/os/barcodes
    • types/os/camera
    • types/os/clipboard
    • types/os/event
    • types/os/files
    • types/os/geolocation
    • types/os/image-classification
    • types/os/input
    • types/os/media
    • types/os/moderation
    • types/os/portals
    • types/os/spaces
    • types/os/system
    • types/os/xr
    • types/records/key
    • types/records/data
    • types/records/files
    • types/records/events
    • types/records/roles
    • types/records/policies
    • types/records/extra
    • types/web
• (Required) Use @docid is used to specify the ID of the function/class in the documentation.
• @docname is used to specify the name that should be displayed in the documentation.
  • This is useful for functions/classes that are exported with a different name than the one used in the code.
  • Use this for functions in AuxLibrary.ts. For example, the toast() function is exported as os.toast().
• Use {@link} to link to other documentation entries.
  • Specify the @docid of the entry you want to link to.
• Use {@tag [tag]} to link to tags.
• Use {@tag @[listener]} to link to listen tags.