javascript - How do I JSDoc A Nested Object's Methods? -


i've been trying use jsdoc3 generate documentation on file, i'm having difficulty. file (which require.js module) looks this:

define([], function() {      /*      * @exports mystuff/foo      */     var foo = {         /**          * @member          */         bar: {             /**              * @method              */             baz: function() { /*...*/ }         }     };      return foo; }

the problem is, can't baz show in generated documentation. instead documentation file foo/foo module, lists bar member, bar has no baz (just link foo's source code).

i've tried changing bar's directive @property instead, , i've tried changing baz's directive @member or @property, none of helps. no matter do, baz doesn't seem want show up.

does know directive structure use baz appear in generated documentation?

p.s. i've tried reading pages 1 on jsdoc site http://usejsdoc.org/howto-commonjs-modules.html, describes cases of foo.bar, not foo.bar.baz.

you can use combination of @module or @namespace along @memberof.

define([], function() {      /**      * test module foo      * @version 1.0      * @exports mystuff/foo      * @namespace foo      */     var foo = {         /**          * method in first level, test          * @memberof foo          * @method testfirstlvl          */         testfirstlvl: function(msg) {},         /**          * test child object child namespace          * @memberof foo          * @type {object}          * @namespace foo.bar          */         bar: {             /**              * test inner method in child namespace              * @memberof foo.bar              * @method baz              */             baz: function() { /*...*/ }         },         /**          * test child object without namespace          * @memberof foo          * @type {object}          * @property {method} baz2 child method property defination          */         bar2: {             /**              * test inner method              * @memberof foo.bar2              * @method baz2              */             baz2: function() { /*...*/ }         },         /**          * test child object namespace , property def.          * @memberof foo          * @type {object}          * @namespace foo.bar3          * @property {method} baz3 child method property defination          */         bar3: {             /**              * test inner method in child namespace              * @memberof foo.bar3              * @method baz3              */             baz3: function() { /*...*/ }         },         /**          * test child object          * @memberof foo          * @type {object}          * @property {method} baz4 child method          */         bar4: {              /**              * @alias , @memberof! tags force jsdoc document              * property `bar4.baz4` (rather `baz4`) , member of              * `data#`. can link property {@link foo#bar4.baz4}.              * @alias bar4.baz4              * @memberof! foo#              * @method bar4.baz4              */             baz4: function() { /*...*/ }         }     };      return foo; });

edit per comment: (single page solution module)

bar4 without ugly property table. ie @property removed bar4.

define([], function() {      /**      * test module foo      * @version 1.0      * @exports mystuff/foo      * @namespace foo      */     var foo = {         /**          * method in first level, test          * @memberof foo          * @method testfirstlvl          */         testfirstlvl: function(msg) {},         /**          * test child object          * @memberof foo          * @type {object}          */         bar4: {              /**              * @alias , @memberof! tags force jsdoc document              * property `bar4.baz4` (rather `baz4`) , member of              * `data#`. can link property {@link foo#bar4.baz4}.              * @alias bar4.baz4              * @memberof! foo#              * @method bar4.baz4              */             baz4: function() { /*...*/ },             /**              * @memberof! memeber              * @alias bar4.test              * @memberof! foo#              * @member bar4.test              */              test : true         }     };      return foo; });

references -

  1. another question nested namespaces
  2. for alternative way of using namespaces
  3. documenting literal objects

*note haven't tried myself. please try , share results.


Comments

Post a Comment

Popular posts from this blog

c++ - CryptStringToBinary API behavior -

i seeing strange behavior cryptstringtobinary cryptography api. please see below code (config: x64 debug): #include "stdafx.h" #include <windows.h> #include <strsafe.h> #include <iostream> #include <exception> void main() { dword dwskip; dword dwflags; dword dwdatalen; //lpcwstr pszinput = l"jaaaaaecaaadzgaaakqaagdnnl1l56bwgfjdgr3rpxtqqqn6daw3usv2emkjym4t"; //this works fine lpcwstr pszinput = l"mytest"; //doesnt work, api returns false,error code 0x0000000d // determine size of byte array , allocate memory. if(! cryptstringtobinary( pszinput, _tcslen( pszinput ) + 1, crypt_string_base64, null, &dwdatalen, &dwskip, &dwflags ) ) { dword dw = getlasterror(); //0x0000000d: data invalid throw std::exception( "error computing byte length." ); } byte *pbytebyte = null; try { ...
Read more

java.util.scanner - How to read and add only numbers to array from a text file -

i'm learning java , have question regarding reading file want read numbers file contains strings well. here example of file: 66.56 "3 java 3-43 5-42 2.1 1 and here coding: public class test { public static void main (string [] args){ if (0 < args.length) { file x = new file(args[0]); try{ scanner in = new scanner( new fileinputstream(x)); arraylist<double> test = new arraylist<>(); while(in.hasnext()){ if(in.hasnextdouble()){ double f=in.nextdouble(); test.add(f);} else {in.next();} } catch(ioexception e) { system.err.println("exception during reading: " + e); } } my problem add 66.56,2.1 , 1 doesn't add 3 after "3 or ignores 3-43 , 5-42 can tell me how skip strings , add doubles here? thanks all said 3 ie; "3, 3-43 , 4-42 strings either u read string , split , check number @ " , - or put in space between characters , integers. jvm after compilation tre...
Read more

iphone - Three second countdown in cocos2d -

i trying have 3 second countdown display when level beat in game. did: -(void) gamesegmentbeat { [self pauseschedulerandactions]; // overlay game opaque background ccsprite *opaquebg = [ccsprite spritewithfile:@"background1.png"]; opaquebg.position = screencenter; [self addchild:opaquebg z:10000]; // these 3 labels 3 seconds cclabelttf *three = [cclabelttf labelwithstring:@"3" fontname:@"helvetica" fontsize:100]; three.position = ccp(screencenter.x, screencenter.y); cclabelttf *two = [cclabelttf labelwithstring:@"2" fontname:@"helvetica" fontsize:100]; two.position = ccp(screencenter.x, screencenter.y); cclabelttf *one = [cclabelttf labelwithstring:@"1" fontname:@"helvetica" fontsize:100]; one.position = ccp(screencenter.x, screencenter.y); // secondspast specified in update method secondspast = 0; if (secondspast == 1) { [self addchild:thr...
Read more