documentation

documentation copied to clipboard

Adding a complete plugin system

3

(Followup to #683) After reading [this part](https://github.com/documentationjs/documentation/blob/master/docs/FAQ.md#why-use-documentation-instead-of-jsdoc) of the FAQ, I thought that documentationjs had a "well documented and flexible" plugin system because it said `Customization points like plugins &...

Telokis

Custom tags

7

I've looked through previous issues as well as the docs, but I can't find anything related to custom tags. I've had a go at passing through a `jsdoc.json` config file...

kasperlewau

Sort order of types in the README injection

1

I’m able to control the sort order of the types when I build HTML docs. However, I can't figure out how to specify the same order for the `readme` command....

jmakeig

The following code works: ``` /** * This is an example. */ class Example { }; module.exports = Example; ``` The following code does not: ``` /** * This is...

Malvineous

Support standard class constructor JSDoc

3

The way that documentation.js forces us to document classes is incorrect: ```js /** * A foo. * @param {*} value Value. */ class Foo { constructor(value) { this.value = value...

jaydenseric

Tag Support Master Ticket

6

✔︎: full support ➖: partial support ✘: no support Complete | Tag | Core | Markdown | HTML | Issues | | --- | --- | --- | --- |...

tmcw

@static doesn't work

1

- version 3.10.10 @static doesn't work. Sample code below. ``` /** * Set directory path to save/load serialized information to/from file. * @method setStoragePath * @param {string} p Absolute or...

kojiy7214

TypeError: Cannot read property 'match' of undefined

3

Code and documentation are confidential and proprietary. Problem arises when running `node_modules/documentation/bin/documentation.js build --format=html --output=documentation $(DOCS_TMP)` via make. Expected result: Documentation built in ./documentation without error. Actual result: ``` TypeError:...

jdsutton

Platform specific files in React Native fail on build

3

**Version: 6.3.2** **Framework: react-native** **File structure:** ``` src | +scenes | | +--AddressInput | +components | +--Geolocator.ios.js | +--Geolocator.android.js ``` **Code:** `import Geolocator from '/components/Geolocator` **cli command:** `documentation serve /src`...

adlondon

When an es6 module exports something imported from a CommonJS style module, documentationJS crashes. ```` export { FOO } from 'some-common-js-dep'; ````

vicapow