cecco974 / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Patch: Show proper class hierarchy on the class description page #172

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
Currently JsDoc toolkit will only show "Extends: foo" at the top of the
class description page. This is better than nothing but it is still
suboptimal for larger class hierarchies. Instead all superclasses of a
class should be shown. Multiple inheritance complicates things somewhat,
but I think the following is sufficient: above the current class show its
superclasses. One line above show the superclasses of these superclasses.
And so on.

The patch attached shows how this could be implemented. And while this is
probably not the best way to do it, and everybody is free to change the
templates for himself - I think that something like that belongs in the
default templates.

Original issue reported on code.google.com by wladi...@palant.de on 8 Jul 2008 at 6:56

Attachments:

GoogleCodeExporter commented 8 years ago
I think there are some people who would find this useful, but me personally, 
I've never felt that this way of 
looking at Javascript (as a classical language with linear inheritance) is very 
useful. In practice you can easily get 
circular and web-like chains of "inheritance" or both!

There have already been templates (Bret Fattori's Old English template for 
example) written with inheritance 
trees, but I don't feel any urge to include them in my own. I would encourage 
you to create a template of your 
own and I will happily provide a link to it on the project templates page (as I 
have done for Bret).

Original comment by micmath on 26 Jan 2009 at 9:48