GNOME Bugzilla – Bug 115531
add short description to index entries
Last modified: 2009-12-23 00:33:35 UTC
looking at javadoc for inspiration, I find variables, classes, interfaces, methods and constants in the index.
We now seem to have classes, interfaces, methods, macros, structs, enums, unions and global variables in the index. Is anything else needed? Maybe individual constants from enums. I noticed that the widget names link to the structs rather than the top of the widget's page. The top of the page is probably better, or maybe have 2 entries - one for the widget and one for the actual struct.
We seem to have enough content in the indices now, but there are some things which are still better in the javadoc indices: - the main index classifies each entry as to what it is, and adds some short blurb: acceleratorFont - Variable in class javax.swing.plaf.basic.BasicMenuItemUI AbstractUndoableEdit - Class in javax.swing.undo An abstract implementation of UndoableEdit, implementing simple responses to all boolean methods in that interface. - the deprecated index is split into "Deprecated Interfaces", "Deprecated Variables", etc
It looks like we don't index signals or properties. (I think this also means they aren't listed in the "new in GTK+ 2.xxx" section) Also, the indices look a bit silly, with every item repeated like this: GtkAboutDialog, GtkAboutDialog Can't we just include it once?
Other improvements that the index has already nowadays: * the index has suffix supression (gtk_window_new under 'w' and gtk_dialog_new under 'd') * there is no silly repetition (GtkAboutDialog, GtkAboutDialog) * we have object properties and signals there I think having a short description in the index (also what it is) is indeed useful. I will investigate how to get there.
Is that better? commit 4f253d2e300e5e5a64ed4c5d99448f432062c879 Author: Stefan Kost <ensonic@users.sf.net> Date: Sun Dec 20 00:10:25 2009 +0200 mkdb: generate a short desc for index entries. Partialy fixes #115531 I could try to figure in which section the symbol is defined and add that as well. Right now it says: gtk_window_new, function Then it could say: gtk_window_new, function GtkWindow having GtkWindow xreffed to the section-id.
Please reopen if more info needed. commit 172468bb66d72075130ec201624c7cc08843ddfb Author: Stefan Kost <ensonic@users.sf.net> Date: Wed Dec 23 02:31:32 2009 +0200 mkdb: add section-link to index entries. Fixes #115531