better-docs

better-docs copied to clipboard

Given this input: ``` /** * The encodings supported by the terminal. */ enum TerminalEncoding { /** * A terminal that does not support any colors. */ NONE, /** *...

cowwoc

Support for react native (Live preview)

1

There is a package ([react-native-web](https://github.com/necolas/react-native-web)), to display react native components to a browser. This would be a great feature

xburelle

jsdoc failing to run: "File doesn't exist there"

3

I had to add `-d=docs` to the command, since jsdoc would not run without it, but I'm still getting an error when I run `jsdoc -c jsdoc.json -d=docs`: ``` java...

HappyCerberus

Typescript class decorators and a static factory method creates a class with _1 suffix

3

When writing a class that has a static factory method which creates a new instance of the class itself, the class will be suffixed with _1 in the created docs....

captnCC

Update component.js

1

added reactDocs resolver "findAllComponentDefinitions", to fix problem with multiple exported components in single file.

ZipJo

Cannot resolve dependency with @component

7

This is probably a windows issue. Trying to use the @component tag results in this in entry.js ``` import Wrapper from '..\node_modules\better-docs\lib\react-wrapper.js'; ``` That should be ``` import Wrapper from...

joshleblanc

Hello, When running parcel I get the following error: >🚨 /Users/user/Documents/project/node_modules/rc-menu/es/SubMenu.js:23:24: Cannot resolve dependency 'mini-> store' > import CSSMotion from "rc-animate/es/CSSMotion"; > import classNames from 'classnames'; > import { connect...

greggailly

Windows parcel error

1

Hi, it has two parcel error: jsdoc.conf.json ``` { "tags": { "allowUnknownTags": true, "dictionaries": ["jsdoc", "closure"] }, "plugins": [ "node_modules/better-docs/typescript", "node_modules/better-docs/component", "plugins/markdown" ], "source": { "include": ["src"], "includePattern": "\\.(jsx|js|ts|tsx)$", "excludePattern":...

pacocom

"Cannot read property 'filePath' of undefined" error for Vue files

2

I'm trying to use better-docs for Vue files, but I always get the following: `TypeError: Cannot read property 'filePath' of undefined`. Here is a copy of my jsdoc.json: ```json {...

leosdad

Error: [BABEL] unknown: Preset /* your preset */ requires a filename to be set when babel is called directly,

2

Trying to generate docs with typescript but I received an error.. > Error: [BABEL] unknown: Preset /* your preset */ requires a filename to be set when babel is called...

Ridermansb