senchalabs/jsduck — Issue #123: Private helpers should not be visible in documentation.
Author: objectkit
Created: 2012-01-24 16:20:26+00:00
State: open

Hi, I have a script that exports a public function, but behind the scenes, it uses a helper object, which I do not want exposed in documentation. In a nutshell, this is equivalent to what I have:

/** @hide */
var helper= {
/** @private */
impl: function () {/*whatever*/}
}

/** @method */
function utility () { return helper.impl()};

Yet in docs, I see helper greyed out, and if click on it, I get the following

NOTE This is a private utility class for internal use by the framework. Don't rely on its existence.

I don't want the helper documented at all! Is this a bug? Shouldn't helper have been omitted from the docs? Thanks!