Skip to content
This repository has been archived by the owner on May 30, 2020. It is now read-only.

Private members are not documented. #78

Open
reloaded opened this issue Apr 22, 2016 · 2 comments
Open

Private members are not documented. #78

reloaded opened this issue Apr 22, 2016 · 2 comments

Comments

@reloaded
Copy link
Contributor

If a member is marked as @private the generated documentation does not indicate that the member is private.

    /**
     * @private
     */
    var userState = {};

image

@allenhwkim
Copy link
Owner

allenhwkim commented Apr 24, 2016

Thanks @reloaded

According to this, http://usejsdoc.org/tags-private.html, private members should not be documented in default

The @Private tag marks a symbol as private, or not meant for general use. Private members are not shown in the generated output unless JSDoc is run with the -p/--private command-line option. In JSDoc 3.3.0 and later, you can also use the -a/--access command-line option to change this behavior.

The @Private tag is not inherited by child members. For example, if the @Private tag is added to a namespace, members of the namespace can still appear in the generated output; because the namespace is private, the members' namepath will not include the namespace.

@reloaded
Copy link
Contributor Author

@allenhwkim If that's the case then as you can see from the screenshot in my post we are indeed generating output for private members. That should be updated so private members are not generated in the HTML.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants