I have a JavaScript singleton object created with closure method:
/**
* This is the singleton.
*
* @namespace window.Something.Singleton
*/
window.Something.Singleton = (function() {
/**
* Foo method.
*
* @return {String} this method always returns with <code>bar</code>
*/
function _foo() { return "bar"; }
/**
* @lends window.Something.Singleton#
*/
return {
/**
* @borrows window.Something-_foo
* @function
*/
foo: _foo
};
}());
But the jsdoc-toolkit does not generate the inherited documentation from _foo
method to the foo
method what I would like to have.
If I write @see
instead of @borrows
it works (inserts a link to the correct method), but I don't want to copy&paste the documentation for the foo
method to have a public documentation as well.