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

@private not working

Open RobAWarner opened this issue 8 years ago • 0 comments

I'm somewhat new to JSDoc stuff but from what I understand, I should be able to add

/**
 * @private
 */

above a function definition and it should not be shown in the generated docs, however adding this seems to have no effect, the function is still documented.

Example:

/**
 * @ngdoc controller
 * @name app.TestController
 * @description
 *   A controller
 */
function TestController() {
    /**
     * @private
     */
    function _init_() {
        return test;
    }
}

_init_ () would still get documented.

RobAWarner avatar Feb 27 '17 11:02 RobAWarner