wenchun / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Feature request: @public tag #101

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
When documenting the Revealing Module Pattern described in http://
www.klauskomenda.com/code/javascript-programming-patterns/#revealing and 
http://www.wait-till-i.com/2007/08/22/again-with-the-module-pattern-reveal-
something-to-the-world/, it would be helpful to have a @public tag to 
indicate which of the internal functions are made public.

Example:

/**
 * Namespace description
 * @namespace
 */
myFunction = function () {
    /**
     * Description of the init method
     * @public
     */
    function init(someParameter) {
        // Do stuff
    }
    /**
     * Description of the methodOne method
     */
    function methodOne() {
        // Do other stuff
    }
    return {
        init: init
    };
}();

Original issue reported on code.google.com by goo...@456bereastreet.com on 23 Mar 2008 at 10:04

GoogleCodeExporter commented 8 years ago
This is in the latest revision of the repository and will be in the next 
release. It
is documented here:

http://www.jsdoctoolkit.org/wiki/?page=public

Original comment by micmath on 23 Mar 2008 at 10:26

GoogleCodeExporter commented 8 years ago
Thanks, that was quick!

Original comment by goo...@456bereastreet.com on 23 Mar 2008 at 10:33

GoogleCodeExporter commented 8 years ago
I started work on this immediately, because I could see it solved another 
problem
(issue #88) which involved automatically marking underscored symbols as 
private. The
new @public tag was the solution to allow those underscored names to appear in 
the
documentation without the "private" tag.

Thanks for your suggestion.

Original comment by micmath on 23 Mar 2008 at 10:58