Как документировать пространство имен с помощью yuidoc?

Question

YUIDoc, похоже, не создает документацию для моего пространства имен. Этот проект использует Revealing Module шаблон проектирования

/* 
* Example namespace. 
* 
* @namespace MY_NAMESPACE 
*/ 
var MY_NAMESPACE = (function() { 
    /** 
    * @property privateProperty1 
    * @type {Number} 
    * @private 
    */ 
    var privateProperty1 = 1; 

    /** 
    * Logs the method name to the console. 
    * @method privateMethod1 
    * @private 
    */ 
    var privateMethod1 = function() { 
    console.log('In privateMethod1'); 
    }; 

    return { 
    /** 
    * @property publicProperty1 
    * @type {Number} 
    */ 
    publicProperty1: 2, 

    /** 
    * Logs a simple message to the console. 
    * 
    * @method publicMethod1 
    * @param {String} aString A string to log. 
    */ 
    publicMethod1: function(aString) { 
     console.log('In publicMethod1 and was passed: ' + aString); 
    } 
    } 
})(); 

Answer 1

@namespace необходимо содержит @class, если вы хотите использовать @namespace следующим образом, но вы можете использовать @class вместо @namespace.

/** 
* Example namespace. 
* @namespace MY_NAMESPACE 
*/ 

/** 
* Example class. 
* @class MyClass 
*/