jsdoc-user

[Jsdoc-user] Documenting JavaScript Innter Types

[Aaron S. <as...@th...>]

Hi, just wondering if JSDoc supports inner types at all?  For example:

 

var myClass = {

            setter: function(){},

            getter: function(){}

}

 

Or if anyone knows/has something that will support this?

 

Thanks,

 

Aaron

Re: [Jsdoc-user] Documenting JavaScript Innter Types

[Michael M. <mi...@gm...>]

Hi  Aaron,

I can tell you that this is possible using JSDoc-2. I've posted a  
working example of how at this URL:

	http://www.jsdoc.info/export/examples/html/picky.html (pick  
"aaron.js" from the drop-menu)

Note that the above website is not "officially" available yet, but  
will soon contain a gallery of working examples and downloadable  
templates. Just thought you might want to see a little preview of how  
your particular example would work.

The source code is:

/**
   myClass - This is my class.
*/
var myClass = {
	/** myClass.setter - Set this. */
	setter: function(){},

	/** myClass.getter - Get this.*/
	getter: function(){}
}

Have a look at the JSDoc-2 wiki for more information on JSDoc-2  
syntax or reply to the mailing list (in the cc) with specific questions.

	http://code.google.com/p/jsdoc-2/

Also, if any other code samples are posted to the list, I'll try to  
add those to the gallery too.

Regards,
Michael

On 9 Mar 2007, at 18:16, Aaron Swain wrote:

> Hi, just wondering if JSDoc supports inner types at all?  For example:
>
>
>
> var myClass = {
>
>             setter: function(){},
>
>             getter: function(){}
>
> }
>
>
>
> Or if anyone knows/has something that will support this?
>
>
>
> Thanks,
>
>
>
> Aaron
>
> ---------------------------------------------------------------------- 
> ---
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to  
> share your
> opinions on IT & business topics through brief surveys-and earn cash
> http://www.techsay.com/default.php? 
> page=join.php&p=sourceforge&CID=DEVDEV________________________________ 
> _______________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user

Re: [Jsdoc-user] Documenting JavaScript Innter Types

[Gabriel R. <gab...@gm...>]

On Fri, Mar 09, 2007 at 10:16:06AM -0800, Aaron Swain wrote:
> Hi, just wondering if JSDoc supports inner types at all?  For example:
> 
>  
> 
> var myClass = {
> 
>             setter: function(){},
> 
>             getter: function(){}
> 
> }
> 

Hi,

Sorry for such a late response. In any case, JSDoc (the first version) doesn't 
support documenting code exactly as you wrote it. The main background
behind that is that only "re-usable class-style constructs" are
documented, and not instance variables (as shown in your example).

Similar (but obviously not exactly the same) constructs are supported,
as shown below:

    function myclass(){}

    myclass.prototype = {
        myfuncOne: function(){
            return null;
        }
    };

> 
> Or if anyone knows/has something that will support this?
> 

I assume you've already heard from Michael, but if not: I believe that
this is taken care of by JSDoc-2.

Regards,

    Gabriel