Typedoc: Only export by default

Created on 13 Aug 2017  路  5Comments  路  Source: TypeStrong/typedoc

Hello, i want to use your package for create documentation for a library i have.
Is is possible to set export only by default? Or just generate export stuff only.
Thanks for the job and have a good day

question

Most helpful comment

@aciccarello i dont want to provide a docs for the internal stuff of the library, just the exported one

All 5 comments

Hello @nicolasgere, can you explain what you mean by "set export only by default"?

@aciccarello i dont want to provide a docs for the internal stuff of the library, just the exported one

@nicolasgere I beleive --excludeNotExported option is what you are looking for. I could not find any mentioning about it in the typedoc docs though so probably this is a documentation issue.

EDIT: After using it for a while I've noticed that this flag has some side effects. Litterrally it also removes defenitions for destructured function parameters.

Bildschirmfoto 2019-07-26 um 11 44 32
a parameter which not exclude not exported stuff, but check this checkbox by default would be also very helpful

It seems like several things are being discussed in this issue:

  • The OP is probably interested in the idea of adding a "library" mode which is discussed in #639
  • If there are issues with the --excludeNotExported option, a new issue should be opened to identify that issue
  • The easiest way to set that checkbox by default would be to create a custom theme
Was this page helpful?
0 / 5 - 0 ratings