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

Non-exported variables shouldn't be documented... #150

Closed
electricessence opened this issue Oct 5, 2015 · 5 comments
Closed

Non-exported variables shouldn't be documented... #150

electricessence opened this issue Oct 5, 2015 · 5 comments
Labels
question Question about functionality

Comments

@electricessence
Copy link

It's getting confusing seeing my local/internal variables/constants/functions documented. :(

These shouldn't be exposed to the consumer, or at least there should be a switch to turn these off.
Personally, they should not be exposed by default. Only what get's exported should be documented.

@electricessence
Copy link
Author

Ok sorry, now I see the checkbox in the UI. But I still think it's weird that it's off by default or even that it's an option. Can we have an option not to have the option? :P

@electricessence
Copy link
Author

Ok I found it :(
--excludeNotExported

@sebastian-lenz sebastian-lenz added the question Question about functionality label Oct 7, 2015
@sebastian-lenz
Copy link
Member

Great, an issue that has resolved itself 😉

@electricessence
Copy link
Author

This behavior still is a bit weird. Because of the checkbox at the top.
It should disappear when this flag is set.

sebastian-lenz added a commit to TypeStrong/typedoc-default-themes that referenced this issue Oct 25, 2015
@sebastian-lenz
Copy link
Member

You are right, the checkbox makes no sense if the parameter is specified, I've adjusted the template.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality
Projects
None yet
Development

No branches or pull requests

2 participants