better-docs

better-docs copied to clipboard

Consider the following definitions: ```js /** @namespace */ const Users = {} /** @namespace */ Users.schema = { // ... } ``` This displays them in the navbar like so:...

jankapunkt

$ npm install -g better-docs **npm WARN deprecated [email protected]: core-js@

sdomville

Consider the following typescript file before it is parsed by this tool: ```ts // example.ts /** @module example */ /** */ export type HelloWorld = { hello: string; world: string;...

AndrewDoesNotComute

Cannot use better docs with vue typescript single file components

4

When I specify that I want to use typescript like this: ` /** * Most top level component * @component * @example * */ export default {} ` I get...

ghost

This is a message displayed after running `npm audit` with better-docs installed. ``` pug =1.3.0-beta.1 Depends on vulnerable versions of vue-docgen-api node_modules/better-docs ``` My question is: Is there a fix...

VladislavKorecky

Hello, i am new to this so the possibility that its not an issue and i am doing it wrong is strong ;) `/** @category core @subcategory login @module Controller...

WebPirat

@Example & Live Preview NOT working

8

So following the basic example from the documentation for React, I can't get @example to render a live preview. Need help. Thank you.

lr001dev

SyntaxError: Unexpected token '.'

3

Whenever I try to run the command "jsdoc -c jsdoc.json" in my terminal I receive the following error: ...node_nodules\better-docs\typescript\type-converter.js:45 let name = node.name?.escapedText ^ SyntaxError: Unexpected token '.' at new...

JimA-cyborg

Export module collection question

3

quninnd

This allows the ability to show / hide private members via the --private flag with jsdoc cli.

donald-richardson-dxd