Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

No inherited methods with @extends #291

Open
filiphoeven opened this issue Dec 1, 2014 · 3 comments
Open

No inherited methods with @extends #291

filiphoeven opened this issue Dec 1, 2014 · 3 comments

Comments

@filiphoeven
Copy link

I don't get to see the inherited methods, even with "Show: Inherited" checked.
I am using this: "Starting YUIDoc@0.3.45 using YUI@3.9.1 with NodeJS@0.10.18"
And I am using the default theme (that I copied to a new dir).
What am I doing wrong?

I used these annotations:

/**
 * A plain popup.
 *
 * @module C
 * @submodule C.D
 * @class a.b.c.d.Popup
 * @constructor
 */
/**
 * A popup with actions.
 *
 * @module C
 * @submodule C.D
 * @class a.b.c.d.ActionPopup
 * @constructor
 * @extends a.b.c.d.Popup
 */

I also tried using @namespace, but it did not make a difference.

/**
 * A plain popup.
 *
 * @module C
 * @submodule C.D
 * @namespace a.b.c.d
 * @class Popup
 * @constructor
 */
/**
 * A popup with actions.
 *
 * @module C
 * @submodule C.D
 * @namespace a.b.c.d
 * @class ActionPopup
 * @constructor
 * @extends a.b.c.d.Popup
 */

Note that I also tried @extends Popup instead of @extends a.b.c.d.Popup two lines above here.

@juandopazo
Copy link
Member

Have you tried using the @module tag in a different block as the @class tag? Something like:

/**
 * A module full of popups.
 * @module C
 */

/**
 * A plain popup.
 *
 * @class a.b.c.d.Popup
 * @constructor
 */

/**
 * A popup with actions.
 *
 * @class a.b.c.d.ActionPopup
 * @constructor
 * @extends a.b.c.d.Popup
 */

I've had only issues with @namespace. I'd stay away from it.

@filiphoeven
Copy link
Author

Hi Juan,

That fixed it, thanks!

Kind regards,
Filip

2014-12-01 19:08 GMT+01:00 Juan Ignacio Dopazo notifications@github.com:

Have you tried using the @module tag in a different block as the @Class
tag? Something like:

/** * A module full of popups. * @module C /
/
* * A plain popup. * * @Class a.b.c.d.Popup * @constructor /
/
* * A popup with actions. * * @Class a.b.c.d.ActionPopup * @constructor * @extends a.b.c.d.Popup */


Reply to this email directly or view it on GitHub
#291 (comment).

@mercmobily
Copy link

Is this something that should be fixed in YUIDoc? (That is, should @module work if it's in the same block as the @class tag?

Or maybe should we document this clearly in the documentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants