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

Include inherit properties and methods #2

Open
codyburleson opened this issue Jan 29, 2019 · 2 comments
Open

Include inherit properties and methods #2

codyburleson opened this issue Jan 29, 2019 · 2 comments
Labels
enhancement New feature or request

Comments

@codyburleson
Copy link

Currently, if a class extends one or more other classes, it does not show the documentation of the properties and methods that it inherits from those classes that are extended. It would would be ideal to do our documentation just like JavaDoc standard, where there is also a "Inherited Properties" and "Inherited Methods" section. Otherwise, developers must explore the higher-level classes in order to figure this out. This is very cumbersome to do. The task here is to first explore the level of difficulty and possibly also prototype a result. Then we can discuss when or how to implement for real if we do indeed decide it is ideal to do so.

@roddolf
Copy link
Collaborator

roddolf commented Mar 25, 2019

Dgeni has already a form to link extended/implemented elements, so extracting that information would be difficult leaving more changes to the templates to include the information.

But since there are other issues about changing the templates (#352), there would be better to plan the new templates/styling/design before.

@roddolf roddolf removed their assignment Oct 1, 2019
@roddolf roddolf transferred this issue from CarbonLDP/carbonldp-js-sdk Oct 1, 2019
@roddolf
Copy link
Collaborator

roddolf commented Oct 1, 2019

With this independent docs project, we can now set the task to render the inherit properties and methods.

@roddolf roddolf changed the title Explore level of difficulty in including extended properties and methods in JS SDK docs Include inherit properties and methods Oct 1, 2019
@roddolf roddolf added the enhancement New feature or request label Oct 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants