[Jsdoc-user] Documenting Name Spaces
Status: Inactive
Brought to you by:
mmathews
|
From: Mark M. <mmi...@ri...> - 2007-10-25 19:05:26
|
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;
}
}
|