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