Jak korzystać JSDoc3 udokumentować zagnieżdżonych nazw

Question

Mam problemy z używaniem JSDoc3 udokumentować kod, który jest zorganizowany wzdłuż tych linii

/** 
* @namespace MyNamespace.MySubNamespace 
*/ 

(function (MyNamespace) { 
    MyNamespace.MySubNamespace.Foo = { 
     doSomething: function (someParam) { 
      // doing it 
     } 
    } 
})(window.MyNamespace) 

Jak użyłbym JSDoc3 celu udokumentowania, że ​​MyNamespace zawiera MySubNamespace który zawiera Foo? Dalej, w jaki sposób skojarzyć doSomething z i udokumentować jego parametr someParam?

Ograniczeniem, które mam, jest to, że nie mogę dodać dokumentacji do pliku, w którym zadeklarowano MyNamespace i MySubNamespace.

Wielkie dzięki!

Answer 1

Wyliczyłem to. Mam nadzieję, że to rozwiązanie pomoże innym.

/** 
* @namespace MyNamespace.MySubNamespace 
*/ 

(function (MyNamespace) { 
    /** 
     * Foo namespace 
     * @namespace Foo 
     * @memberOf MyNamespace.MySubNamespace 
     */ 
    var Foo = { 
     /** 
      * Does something. 
      * @memberOf MyNamespace.MySubNamespace.Foo 
      * @param {object} someParam Some parameter. 
      */ 
     doSomething: function (someParam) { 
      // doing it 
     } 
    }; 
    MyNamespace.MySubNamespace.Foo = Foo; 
})(window.MyNamespace)