Skip to content

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

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

Closed
AdrianVasiliu opened this issue Apr 3, 2014 · 2 comments
Closed

Comments

@AdrianVasiliu
Copy link

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:

@AdrianVasiliu
Copy link
Author

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.

@asudoh
Copy link
Contributor

asudoh commented Jun 13, 2014

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

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

No branches or pull requests

2 participants