documentation

documentation copied to clipboard

Remove lodash dependency

1

It's not used too often and removing it will improve the install time and reduce the bundle size. I'm happy to tackle this if there's interest

vicapow

Happy to contribute this, if there's interest.

vicapow

Add option to ignore location in json format

1

Currently, when we generate the JSON docs, It includes the location. The location includes the filename (absolute path with USERNAME). Here is sample code from the JSON docs of `documentation.js`...

BugDiver

Predictable Doc Output Format for GraphQL

3

This is more a feature request/future planning idea. Right now, the JSON output of a doc parsing run cannot (easily) be used with something like GraphQL because it requires a...

webOS101

Option to automatically group files in modules

6

I'm a big fan on inferring documentation properties from code: I'm using _documentation.js_ mainly because it allows me to omit the ‘boring’ parts of doc comments by using Flow types....

killercup

@module does not add "All symbols in the file"

9

JSDoc standard: >All symbols in the file are assumed to be members of the module unless documented otherwise. This does not happen. Mentioned in #234 but there is no specific...

rbong

Protected methods of a class are not marked in any way in HTML output

2

The following class has one `public` and one `protected` method. The `protected` one is not marked as protected in any way in the HTML output. When in JSON, it is...

ipeychev

Markdown only theme

1

I've just finished a documentation.js theme that renders to plain markdown, so I can integrate the output in my documentation generator ([mkdocs](https://www.mkdocs.org/) in this case). Since the default markdown output...

Radiergummi

Crashes on ESLint require-jsdoc directive comments

4

This bug confused the heck out of me! This: ```js // eslint-disable-next-line require-jsdoc const Foo = () => ``` Or this: ```js /* eslint-disable require-jsdoc */ const Foo = ()...

jaydenseric

CLI lint warning bug

2

In `src/test.js`: ```js const foo = { bar: () => {} } /** A baz. */ class Baz {} ``` Running `documentation lint src` results in this warning: ``` 5:1...

jaydenseric