Compact list (summary) of properties, methods, and events
AdrianVasiliu opened this issue · comments
Adrian Vasiliu commented
The JSDoc output is potentially a long page with no summary.
For comparison:
- Examples of API docs including such facilities: Dojo, OpenLayers, ArcGIS, emberjs, closure.
- A project using a custom JSDoc template including a method summary: lightstreamer (also includes an index).
Examples of GUI:
Dojo:
Related issues already registered at jsdoc3:
- lack of “method summary”: jsdoc/jsdoc#296
- lack of expansible/collapsible TOC: jsdoc/jsdoc#43
- “default template appearance”: jsdoc/jsdoc#270