documentation icon indicating copy to clipboard operation
documentation copied to clipboard

:book: documentation for modern JavaScript

Results 138 documentation issues
Sort by recently updated
recently updated
newest added

I was surprised I had to add `@private` for `#`-prefixed functions to be recognized as private, it seems relatively straightforward to infer. Possibly related: #1355

Hey, thank you for this project! It would be nice if the CLI supported a `--watch` option that would monitor input files and automatically generate output files. I know there...

**If you're reporting a bug, please include _input code_, _output documentation_, I upgraded from 13.2.5 to 14.0.1 but i cant figure out how to import the node api anymore. This...

In `.d.ts` it is valid to have a `const` without an initializer: ```ts export const version: readonly; ``` but documentation.js chokes on it

```shell git clone https://github.com/documentationjs/documentation.git documentation-upstream cd documentation-upstream npm run build ``` ``` > [email protected] build > npm run doc > [email protected] doc > node ./bin/documentation.js build src/index.js -f md --access=public...

Bumps [@vue/compiler-sfc](https://github.com/vuejs/core/tree/HEAD/packages/compiler-sfc) from 3.2.37 to 3.4.26. Release notes Sourced from @​vue/compiler-sfc's releases. v3.4.26 Please refer to CHANGELOG.md for details. v3.4.25 Please refer to CHANGELOG.md for details. v3.4.24 Please refer to...

dependencies
javascript

Bumps [@babel/parser](https://github.com/babel/babel/tree/HEAD/packages/babel-parser) from 7.18.11 to 7.24.5. Release notes Sourced from @​babel/parser's releases. v7.24.5 (2024-04-29) Thanks @​romgrk and @​sossost for your first PRs! :bug: Bug Fix babel-plugin-transform-classes, babel-traverse #16377 fix: TypeScript...

dependencies
javascript

### Description Error occurs when specifying custom theme on v14 series. ### How are you running documentation.js Node.js API ### Version documentation.js version:v14.0.3 Node.js version: v20.10.0 OS: Windows 10 ###...

For below docstring: `@param { Required & Partial } body specification` expectation is to see below format in documentation: `body(Required & Partial) specification` but I can see: `body(any) specification` version...

I'm currently writing the documentation for my codebase, but I'm getting weird output when trying to unpack an Object in JSDoc to describe its properties. ``` /** * Foundational class...