12 Commits

Author SHA1 Message Date
Anton Shchekota
e3c59d77e4 fix: external was removed as prefer of input usages
BREAKING CHANGE:
external parameter was removed
Migration plan propose to move all external resources to input usages
Motivation: packages has many inputs which describe in package.json
so that mean need each time to parse all package.json of exsternal resources to understand which etry point need to pick.
But it is base on guesses because entry point may could not contains a documentation and the best way to handle it manualy.
2021-11-11 11:52:31 +03:00
Yicheng (Jerry) Gong
15bbc063da Adding additional cli option, markdown-toc-max-depth for configuring markdown-toc maxDepth (#1215) 2019-03-12 11:42:43 -07:00
Jonas Bögle
5b045f26c0 feat: Add favicon option (#1207) 2019-02-22 08:11:26 -08:00
Max Schmitt
45a9ea924a feat: added project description 2018-08-03 15:35:25 -07:00
Jonas Bögle
f0c32278a8 docs(readme, usage): updated help command/message (#994) 2018-01-12 16:00:23 -08:00
Tom MacWright
5b373ff2fe revert(polyglot): Remove polyglot mode
BREAKING CHANGE: I'd like to still support C++ and other languages in the future! But I'm much
happier doing so by separating the extraction & input phases to the degree that documentation.js can
read the output of another module that extracts JSDoc comments from C++ code, rather than having CPP
support in it.

Fixes #850. Fixes #731. Fixes #702. Fixes #132.
2017-07-27 13:58:49 -04:00
Erik Arvidsson
a5ac4a798c Add a --sort-order option (#535)
Valid values for the `--sort-order` flag are `"source"` (default) and
`"alpha"`. When set to `"alpa"` the order of the entries in the docs
are sorted alphabetically.

Fixes #534
2016-09-08 18:26:02 -04:00
Tom MacWright
49347c82e7 Arv document exported (#502)
* Add a flag to document all exported bindings

This adds a boolean flag called `document-exported` (defaults to false)
that effectively adds an empty comment to all exported bindings that do
not already have a JSDoc comment. It also does the same for the
members of exported classes and objects.

```js
export class C {
  method() {}
}
```

Both `C` and `C#method` are now part of the generated documentation.

Related to #424

* Fix lint error

* Rebase and use options pragma in test file

* Create extractor type as a generalized comment/export getter

* Document exported extractor
2016-08-24 10:58:15 -04:00
Erik Arvidsson
629ea6f3a8 Add support for inferring private based on the name
This adds a command line flag called `--infer-private` which is a
string (defaults to `^_`) which is used as a regexp for inferring
if a name is private or not.

For example:

```js
/** C */
class C {
  /** I'm public */
  m() {}
  /** I'm private */
  _p() {}
}
```

Fixes #436
2016-06-01 14:40:08 -07:00
Andreas Hocevar
6e352a1049 Add commands, update options and fix example 2016-03-09 14:25:19 +01:00
Tom MacWright
fb9fcfb2d3 Update -h examples, fix reference to streams 2015-10-30 17:57:39 -04:00
Tom MacWright
017c6c5aa2 Add streams to eslint coverage, organize docs 2015-07-10 10:56:45 -04:00