¿Cómo se documentan los espacios de nombres en JavaScript?

Question

¿Cómo se pueden documentar los espacios de nombres en JavaScript con jsDoc?

Aquí está mi intento, ¿es esto correcto?

/** 
* My special namespace 
* 
* @name my.namespace 
* @namespace 
*/ 
$namespace('my.namespace', /** @lends my.namespace **/ { 
    /** 
    * Foo - does something really neat... 
    * @function 
    */ 
    foo: function() { 
    } 
}); 

sólo para aclarar, lo anterior se utiliza como sigue:

my.namespace.foo(); 

Answer 1

Esta función está disponible en jsdoc3 micmath/jsdoc. La sintaxis de jsdoc3 es diferente a jsdoc-toolkit (jsdoc2)

El siguiente ejemplo fue por Michael jsdoc and pseudo-namespaces?

/** 
* Document me. 
* @namespace my 
*/ 

/** 
* My special namespace 
* @namespace my.namespace 
*/ 
$namespace('my.namespace', /** @lends my.namespace **/ { 
    /** 
    * Foo - does something really neat... 
    */ 
    foo: function() { 
    } 
});