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

Hide private members #6

Closed
pklaschka opened this issue Jan 7, 2021 · 0 comments
Closed

Hide private members #6

pklaschka opened this issue Jan 7, 2021 · 0 comments
Assignees
Labels
🌷 enhancement New feature or request
Milestone

Comments

@pklaschka
Copy link
Member

As I looked around, I noticed that all members of a class are exported regardless if the member is public or private.
As far as I now, fliegdoc should only generate documentation for exported types.
Is a private member of a class an exported type?

For example, we have the following class:

export class MyClass {
  /**
   * This is my private value!
   */
  private myPrivateValue: string;

  /**
   * this is my public function hello!
   */
  myFunction(): void {
    console.log('Hello World');
  }
}

Which generates to:
Screenshot_20210107_182507

Any ideas? :)

Originally posted by @fussel178 in #5

@pklaschka pklaschka self-assigned this Jan 7, 2021
@pklaschka pklaschka added the 🌷 enhancement New feature or request label Jan 7, 2021
@pklaschka pklaschka added this to the v0.4.0 milestone Jan 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌷 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant