Skip to content
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

Typedoc is inconsistent in excluding not exported symbols #1141

Closed
1 task done
mvlabat opened this issue Nov 25, 2019 · 2 comments
Closed
1 task done

Typedoc is inconsistent in excluding not exported symbols #1141

mvlabat opened this issue Nov 25, 2019 · 2 comments
Labels
bug Functionality does not match expectation

Comments

@mvlabat
Copy link

mvlabat commented Nov 25, 2019

I tried several combinations of organizing class exports and filtering them out in the docs, here's what I got:

/**
 * Appears in the docs if "Only exported" is checked in the UI,
 * but doesn't if `excludeNotExported` is set to true in `typedocOptions`.
 */
class TestDefault1 {}

export default TestDefault1;
/**
 * Appears in the docs for both "Only exported" in the UI and
 * `excludeNotExported` set to true in `typedocOptions`.
 */
export default class TestDefault2 {}
/**
 * Won't appear in the docs as exported.
 */
class TestDefault3 {}

export { TestDefault3 as default };

I've set up a small repository to reproduce the issue:
https://github.com/mvlabat/typedoc-exported-issue

Environment

  • Typedoc version: 0.15.0
  • Node.js version: v12.10.0
  • OS: macOS Catalina 10.15.1 (19B88)
@mvlabat mvlabat added the bug Functionality does not match expectation label Nov 25, 2019
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 26, 2019

This is expected. We don't support export declarations yet. The work to support them is being tracked in #801

@mvlabat
Copy link
Author

mvlabat commented Nov 27, 2019

@Gerrit0, thank you for your response. I guess this issue can be closed then

@mvlabat mvlabat closed this as completed Nov 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants