Pixi.js: JSdoc Bug with Members

Created on 6 Dec 2016  路  9Comments  路  Source: pixijs/pixi.js

Some members are not showing up in the docs. For instance: PIXI.Sprite#blendMode.

Example:
http://pixijs.download/dev/docs/PIXI.Sprite.html

This issue was noticed with #3413.

馃捑 v4.x (Legacy) 馃暦 Bug

All 9 comments

It seems no public members are displaying by default. To have them displayed you currently need to use @memberOf which makes @private seem a bit redundant. See #3471.

Indeed, I've found that with jsdoccing my game, which also uses es6 classes. Public functions are output, but not public members. @private isn't redundant as it'll correctly assist IDEs. Maybe there's some JSDoc configuration somewhere to pull in the public members

Annoyingly, even if you set "private" to true in scripts/jsdoc.conf.json - that outputs private functions to the docs... but still no members at all. :8ball:

Is this a bug with jsdoc?

I believe so, can't see a config option for it

I've raised an issue on JSDoc github (https://github.com/jsdoc3/jsdoc/issues/1301) - we'll see what they say

I'm having the same problem, but it looks as though it was reported over a month ago (https://github.com/jsdoc3/jsdoc/issues/1293). According to this report it has to do with using @export in the module that contains the class.

Fixed with #3542

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

Was this page helpful?
0 / 5 - 0 ratings