JSDoc plugin to add class hierarchy data, and optionally an HTML list representation of the same.
It uses the
processingComplete events given by JSDoc, and
augments property in the doclets. This is added when the
tag is used.
Install using npm:
npm install jsdoc-class-hierarchy --save-dev
Add to the plugins in your JSDoc config:
||boolean||Whether or not to show an HTML list of the children classes and hierarchy.
If you use the plugin with
showList enabled you automatically get a styled
HTML list in your class description. This is is the easiest way of using the
It will result in something like this:
If you don't like this display you can update your theme to show this data
however you like. Doclets of classes that have subclasses will have a
children key. All classes that are subclasses of another class will have the
hierarchy key. Both are arrays of strings, with the class on top of the
hierarchy being the first one.
docletchildren = 'OO.ui.ToolGroup' 'OO.ui.Tool' ;doclethierarchy = 'OO.ui.Element' 'OO.ui.Widget' ;