You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
With this independent docs project, we can now set the task to render the inherit properties and methods.
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
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.
The text was updated successfully, but these errors were encountered: