-
Notifications
You must be signed in to change notification settings - Fork 721
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Re-exports are not documented. #712
Comments
Hello @cameron-martin, Take a look at #259 which talks about some issues with re-exporting. I also would love to see the ability to document only a public API (like is described in #639). This would help handle libraries much better. |
I use façades that make heavy usage of
because it is functionally the same as
However both Then there are the complications that export declarations introduce. (Terminological note:
Cases 1 and 2 are currently handled ambiguously. Producing output for cases 3, 4, 5 right now would result in ambiguities worse than 1 and 2. typedoc should systematically indicate in the generated documentation which symbols are available internally and which are available externally, this would resolve the ambiguity of cases 1 and 2 and would help tremendously with the other cases. Here's what I think should happen in each of the cases above:
In the description above, I've set things up so that [exported] is omitted whenever |
It looks like Microsoft's API Extractor can help with this - particularly if you want to do the rendering yourself. |
I am wanting to document an NPM package that is made up from multiple files, but re-exports the public interface at a top-level
index.ts
file, e.g:index.ts
foo.ts
bar.ts
In this example,
Baz
is exported fromfoo.ts
so that it can be used in other parts of the library, but is not part of the public interface of the library.I am using typedoc to output json, then passing that to a custom renderer. However, the json contains no documentation entries for
index.ts
, instead only including documentation entries under the files where the class/function was originally exported.However, I want to only render documentation for the things that are exported from the top-level
index.ts
file, and there seems to be no way to determine this from what typedoc outputs. Is there a workaround for this?The text was updated successfully, but these errors were encountered: