angular-jsdoc icon indicating copy to clipboard operation
angular-jsdoc copied to clipboard

Private members are not documented.

Open reloaded opened this issue 9 years ago • 2 comments

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

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

image

reloaded avatar Apr 22 '16 21:04 reloaded

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.

allenhwkim avatar Apr 24 '16 11:04 allenhwkim

@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.

reloaded avatar Apr 24 '16 16:04 reloaded