wenchun / jsdoc-toolkit

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

More information in the overview index #97

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
On behalf of withinsea:

I got not much classes in my package... instead there's a crowd of
static functions.
But neither the class index nor the file index can supply a full
overview of all this non-class members.

How about to consider an overview index including everything? For
example, just like :

+ toolkit
     + html
         {Field} BLAH_BLAH
         {Method} foo (o, p, q)
         {Method} bar ()
         {Class} BlahException (msg)
         .....
     + css
         ....
     + util
        ....

Details (like where to place description, whether to contains
parameter types...) can be left to theme...

Original issue reported on code.google.com by micmath on 13 Mar 2008 at 8:14

GoogleCodeExporter commented 8 years ago
Since this issue was created I have seen this functionality accomplished by 
users via custom templates. On one 
project for example, an "a to z" listing of all the symbols in the library is 
created. This proves that if it is desired 
it can already be accomplished by customizing your own template, but since I 
want to keep the standard 
template minimal and generic I am not going to add such a feature to the 
standard template. I am leaving it to 
you to implement this yourself, or ask people to share their custom templates 
on the user discussion group.

Original comment by micmath on 21 Jun 2009 at 12:41