how to document such things

[XianA...@gmail.com]

hi there, everyone.

I am a newbie to JsDoc Toolkit, and occur something I can't solve,
hope you give me a hand, thanks advance.

The problem is, when I use the "module pattern", documentation in the
return exprssion would missssss...for example:

var Foo = function(){

var private = here;

return {

@static
@desc descriptions here.

method1: function(){
//blah blah codes here
}

}

}();

JsDoc Toolkit will igore everything in the return block, so how can I
get it worked?

realazy

[Michael Mathews]

Hello,

I believe you just need the @scope tag, like so:

var Foo = function(){
    var private = here;

    /** @scope Foo */
    return {

        /**
         * @static
         * @desc descriptions here.
         */

        method1: function(){
            //blah blah codes here
        }
    }
}();

That tag is mentioned on the wiki under the heading "Changing Scope" here:
    http://code.google.com/p/jsdoc-toolkit/wiki/DocExamples

Note: As I look at it I realize that page needs updating, so don't consider it complete. Feel free to ask if you have any further questions.

Regards,
Michael

[XianA...@gmail.com]

Hi, Michael.

Thanks for your reply.

I have used JsDoc Toolkit in my project, it's so fantastic! thank u,
Michael.

regards,
realazy from Beijing, China :)

On Aug 28, 5:19 pm, "Michael Mathews" <micm...@gmail.com> wrote:
> Hello,
>
> I believe you just need the @scope tag, like so:
>
> var Foo = function(){
> var private = here;
>
> /** @scope Foo */
> return {
>
> /**
> * @static
> * @desc descriptions here.
> */
> method1: function(){
> //blah blah codes here
> }
> }
>
> }();
>
> That tag is mentioned on the wiki under the heading "Changing Scope" here:
> http://code.google.com/p/jsdoc-toolkit/wiki/DocExamples
>
> Note: As I look at it I realize that page needs updating, so don't consider
> it complete. Feel free to ask if you have any further questions.
>
> Regards,
> Michael
>

[Michael Mathews]

You're welcome, realazy. If you'd like to post a link to your project, I would be interested in seeing it.

Regards,
Michael