ibm-js / jsdoc-amddcl

An effort to create a JSDoc template that works well with AMD and C3MRO-based multiple class inheritance.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Ability for the reader of the doc to turn on/off the inherited APIs

AdrianVasiliu opened this issue · comments

With the current template, the doc of a class includes all inherited APIs (except if it has the @mixin tag). This is covered by the issue #5 ("Implement a way to hide methods inherited from superclass"). Now, when this will be implemented, it would still be nice to allow the reader of the doc to turn on/off the inherited APIs.

For comparison, examples of API docs including such facilities:

Thanks a lot, that's very nice!

I've seen only one small glitch: the doc of a class which does not have any inherited member still shows "Show inherited", and once you click it, it turns into "Hide inherited"; clicking again it does not turn back into "Show inherited". All in one, it would be nice to filter out the button/link when there's no inherited member.

Thanks @AdrianVasiliu for finding that, fixed: asudoh@57e52af