documenting constructors and config options

[Arthur K]

Say I have a class written as such:

/**
* @class Foo.Bar
* The description for my class
* @namespace Foo
*/
Foo.Bar = function(configA, configB) {
/**
* @property
*/
this.myProperty = null;
...
};

What is the best way to document my constructor? Technically I haven't
written a method, so I'm not sure where the best place would be to
place documentation tags (same for config options).

Any advice?

[oxymoron]

In fact you've just found a defect. I'll try to explain...
To declare constructor and its parameters you have to use @constructor
tag as follows:

/**
* @class Foo.Bar
* The description for my class
* @namespace Foo

* @constructor
* @param {Object} configA This is my config
* @param {Object} configB This is another config

*/
Foo.Bar = function(configA, configB) {
/**
* @property
*/
this.myProperty = null;

/**
* @method
*/
this.myMethod = function(){};
};

Here you can see one more @method declaration.
The problem is - if you remove this @method - constructor docs will
not appear!

Try to do it. It would be good if you submit issue to the issue list.

[Arthur K]

Okay, so as long as there's one @method declared (which could be a
totally different method from the constructor) the constructor shows
up. If no methods are documented, the constructor doesn't show up.

I'll add as a bug. Thanks!