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

@private not working #107

Description

@RobAWarner

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions