phihag / typedoc-demo

Demonstrate --excludeNotExported not working in typedoc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

typedoc demo - how to exclude not-exported JavaScript symbols?

I want to use typedoc to generate a library documentation. I want public symbols to be visible. However, private symbols that are not importable from outside should not be visible.

To test:

$ npm i
$ ./node_modules/.bin/typedoc --out tsdoc --noEmit --excludeNotExported --stripInternal
$ grep Internal tsdoc/modules/_example_.html
    <p>Internal function, should not be documented.</p>

In other words, the internal function bar from example.js got documented, although --excludeNotExported has been set.

Update

This is a well-known issue.

About

Demonstrate --excludeNotExported not working in typedoc


Languages

Language:JavaScript 100.0%