@hideconstructor does not hide constructor

[ozum]

Hi,

I'm using @hideconstructor to hide constructor from markdown documents. I even coupled it with @private, but constructor is always documented.

Example (I tried every combination of @private and @hideconstructor)

/**
 * Some details
 * @public
 * @hideconstructor
 */
class MyClass {
  /**
   * Constructor details
   * @private
   * @hideconstructor
   */
  constructor() {
    this.attr = 1;
  }
}

Kind Regards,

[75lb]

Needs some investigation, thanks. Historically, there was a reason @private had no effect on constructors (because jsdoc output made no distinction between a class and function declaration, i think) but it needs revisiting, since jsdoc has been updated.

[curquhart]

any updates on this?

[75lb]

does this input code produce the desired output in jsdoc v3.6.2?

[ozum]

does this input code produce the desired output in jsdoc v3.6.2?

@75lb, I checked with jsdoc v3.6.2 now. Yes it produces desired ouput with @hideconstructor.

[fenomas]

After much painful experimentation, I noticed a possible workaround for this issue. Currently, it seems that class constructors show up (or not) in the doc output depending on whether or not there is any description text in the class comment.

That is, with source like this the constructor shows up in the output for me:

/**
 * Here's a description
 * @class
 * @hideconstructor
*/

function Foo() {
	/** a property */
	this.property = 1
	/** method */
	this.method = function () { }
}

But when I remove the untagged description text, I get no constructor in the doc output:

/**
 * @class
 * @classdesc Here's a description
*/

function Foo() {
	/** a property */
	this.property = 1
	/** method */
	this.method = function () { }
}

For me @hideconstructor has no apparent effect either way.

[75lb]

hideconstructor: true is included in the jsdoc2md --json template data (which gets passed into dmd), meaning it should be possible to respect this flag. For example, here's the template data from the code used in the jsdoc docs:

  {
    "id": "WaffleIron",
    "longname": "WaffleIron",
    "name": "WaffleIron",
    "kind": "class",
    "description": "Waffle iron singleton.",
    "meta": {
      "lineno": 5,
      "filename": "0-src.js",
      "path": "/Users/lloyd/Documents/jsdoc2md/testbed/build/jsdoc/global/hideconstructor"
    },
    "hideconstructor": true,          <-- here
    "scope": "global",
    "order": 0
  },

Will look into it..

[75lb]

Implemented and available in the jsdoc2md v9 pre-release which you can install and test, if you like.

There's an example of the output in the testbed.