jsdoc-user

[Jsdoc-user] Documenting Name Spaces

[Mark M. <mmi...@ri...>]

I am new to JSDoc and I have not been able to find a way for it to
produce documentation based on namespaces.
Here is an example of how we are defining namespaces.Jsdoc fails to
document this no matter which options I try.
Since this is a valid way to define namespaces then Jsdoc should support it.

         
/**
 *  Survey System name space
 *
 * @version      1.5
 * @author       Mark Mitchell <mmi...@ri...>
 * @name         Survey System
 * @constructor
 *
 */
var SS = {   

    /**
     * Survey system form object set in pageInit()
     */
    objForm : null,
 
    /**
     * Page init function
     *
     * @access  public
     * @since    1.0
     * @return   void
     */
    pageInit : function() {
       this.objForm = document.forms[0];
       return;
    }
}

Re: [Jsdoc-user] Documenting Name Spaces

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

Hi Mark,


> I am new to JSDoc and I have not been able to find a way for it to
> produce documentation based on namespaces.
> Here is an example of how we are defining namespaces.Jsdoc fails to
> document this no matter which options I try.
> Since this is a valid way to define namespaces then Jsdoc should support it.

This is indeed a valid way to define a namespace in JavaScript. On the
other hand, it could also be looked at as a valid way to define a
variable, or a Singleton instance, or any other number of things. The
point I'm getting at here is that JavaScript is a very flexible
language, and JSDoc is somewhat limited in what it knows how to deal
with.

The good news is that there is a newer documentation tool that is
somewhat similar to JSDoc which may be able to handle this: JsDoc
Toolkit (http://www.jsdoc.info). JSDoc actually isn't really being
actively maintained anymore, and support for constructs like this
certainly aren't planned to be implemented, so you'll probably have a
lot more luck with JsDoc Toolkit.


Regards,

Gabriel