Re: index support

[James Henstridge <james daa com au>]

Matthias Clasen wrote:

> I have attached a patch adding index support to gtk-doc to 
>
> http://bugzilla.gnome.org/show_bug.cgi?id=92861
>
> Here is what I wrote in the bug:
>
> Here is a patch to make gtk-doc support index creation. In order to
> use it, simply add an <index/> element at the proper spot in your
> driver document. gtk-doc emits two index entries per symbol, one
> primary one and a secondary one under the symbol type, e.g. the
> G_LIKELY() macro will produce an entry "G_LIKELY()" under "G" and an
> entry "macros, G_LIKELY()" under "M".
>
> Do you think this is a good idea ?
>  
Having an index sounds like a good idea, but it might be worth thinking 
a bit more about what to put in the index.  The reporter of that bug 
seems to want to be able to search for individual components of function 
names (eg. which widget has a pack_start() method?).  Having just 
"identifier" and "identifiertype, identifier" in the index may not help 
much more.  Maybe an index of method names (with the object prefix 
stripped from the identifier) might help?  I don't know what format 
would be best for the index terms though.  Maybe one of these?
   set_shadow_type() method,
       GtkScrolledWindow object
       GtkTextView object
   ...
  

On the other hand, simply having all the identifiers on a single web 
page might be enough for him ...

James.

--
Email: james daa com au
WWW:   http://www.daa.com.au/~james/