Documenting member functions with JSDoc

Question

I have something like this:

/**
Diese Klasse bla bla...
@constructor 
**/
my.namespace.ClassA = function(type)
{
   /**
   This function does something
   **/
   this.doSomething = function(param){
   }
}

The class will get listed in the generated documentation. The function won't. Is there a way to tell JSDoc (3) that this is a member function of the class ClassA?

score 12 · Answer 1 · answered Jan 13 '14 at 17:12

12

Try this!

/**
  * Diese Klasse bla bla...
  * @constructor 
*/
my.namespace.ClassA = function(type)
{
   /**
    * This function does something
    * @function doSomething
    * @memberOf my.namespace.ClassA#
   */
   this.doSomething = function(param){
   };
};

JSDoc seems quite clunky in this area :/ The key is to specify both memberof and the name of the function. See also.

answered Jan 13 '14 at 17:12

Chris

5,876
3
43
69

1

Thanks, the _only_ working solution I found in _hours_. Pointed me in the right direction. _Clunky_ does not make enough justice to this kind of a mess ... – famousgarkin Jul 17 '15 at 17:36
I've been scratching my head for hours now. This fixed it. Thank you so much! – andersevenrud Jul 02 '16 at 18:12

score 6 · Accepted Answer · answered Sep 23 '13 at 12:23

6

JSDoc needs some additional information to recognize the function as member function:

/**
  * Diese Klasse bla bla...
  * @constructor 
*/
my.namespace.ClassA = function(type)
{
   /**
    * This function does something
    * @function
    * @memberOf my.namespace.ClassA
   */
   this.doSomething = function(param){
   }
}

answered Sep 23 '13 at 12:23

Matti Lehtinen

1,694
2
15
22

4

Now if i use it that way. It will display `` in front of the function body. But it's not a static function. If i use "@instance" to tell jsdoc that this is an instance function it will disappear again. Any Idea? – Chris Sep 24 '13 at 07:10
Does it help if you change it to `@memberOf my.namespace.ClassA.prototype`? – Matti Lehtinen Sep 24 '13 at 09:43
No, it still disappears – Chris Sep 24 '13 at 12:17
2

For anyone who might be wondering this, using *only* the `@instance` tag does the trick. – spicypumpkin Jun 24 '17 at 00:26
Another problem could be the memberOf instead memberof (all lowercase). I had a problem with that in the past. – sebastianf182 Nov 16 '17 at 18:22

score 0 · Answer 3 · edited Dec 25 '22 at 10:31

0

You need to explicitly describe the function using full namepath. There are 3 types of namepath syntaxes to describe functions:

Person#say  // the instance method named "say."
Person.say  // the static method named "say."
Person~say  // the inner method named "say."

See details in this page.

edited Dec 25 '22 at 10:31

Patrick Hund

19,163
11
66
95

answered Jun 07 '16 at 13:46

gm2008

4,245
1
36
38

Documenting member functions with JSDoc

3 Answers3

Linked