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

Docs should omit children of private modules #129

Open
hegemonic opened this issue Jan 15, 2015 · 1 comment
Open

Docs should omit children of private modules #129

hegemonic opened this issue Jan 15, 2015 · 1 comment
Assignees
Labels
Milestone

Comments

@hegemonic
Copy link
Owner

The output for JSDoc currently has some wonkiness related to module:jsdoc/runtime. The comment that includes the @module tag is also tagged @private, but some static methods are not tagged @private. As a result, those static methods show up on the index page, which pulls from all known doclets. We also generate a pretty-printed source file.

If a module is private, we should hide all of its descendants from the docs. Also, we should not generate a pretty-printed source file for the module.

We should check the behavior of namespaces and classes to make sure they don't have a similar issue.

@hegemonic hegemonic added the bug label Jan 15, 2015
@hegemonic hegemonic self-assigned this Jan 15, 2015
@hegemonic hegemonic added this to the 0.1.0 milestone Jan 15, 2015
@hegemonic
Copy link
Owner Author

Namespaces and classes have the same issue.

However, it may be tricky to solve this without a performance hit. I think we'd have to keep (and iterate over) a bunch of private doclets that we currently throw away.

@hegemonic hegemonic modified the milestones: 0.5.0, 0.1.0 Jan 16, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant