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

Modules with only non-exported constructs should not be exported either #1126

Closed
1 task done
alalonde opened this issue Nov 6, 2019 · 1 comment · Fixed by #1171
Closed
1 task done

Modules with only non-exported constructs should not be exported either #1126

alalonde opened this issue Nov 6, 2019 · 1 comment · Fixed by #1171
Labels
bug Functionality does not match expectation help wanted Contributions are especially encouraged

Comments

@alalonde
Copy link
Contributor

alalonde commented Nov 6, 2019

Expected Behavior

In a file with only @internal exports, the module corresponding to that file should not be exported either, and not show up in the "Globals" section. Assuming mode="modules"

Actual Behavior

The module is exported but empty. There is a link to it in the "Globals" section.

Steps to reproduce the bug

With this file src/internal.ts:

/**
 * @hidden
 */
export class Internal {
  ...
}

typedoc --mode="modules" --excludeNotExported src/

Environment

  • Typedoc version: 0.15.0
  • Node.js version: 10.8
  • OS: Mac OS 10.12
@alalonde alalonde added the bug Functionality does not match expectation label Nov 6, 2019
@alalonde alalonde changed the title With --excludeNotExported, modules with only non-exported constructs should not be exported either Modules with only non-exported constructs should not be exported either Nov 6, 2019
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 6, 2019

PR welcome, this should only require minor changes.

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 help wanted Contributions are especially encouraged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants