After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 696904 - each class name is listed twice
each class name is listed twice
Status: RESOLVED FIXED
Product: devhelp
Classification: Applications
Component: General
3.7.x
Other Linux
: Normal normal
: ---
Assigned To: devhelp-maint
devhelp-maint
Depends on:
Blocks:
 
 
Reported: 2013-03-30 12:45 UTC by Adam Dingle
Modified: 2016-01-27 14:38 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Adam Dingle 2013-03-30 12:45:48 UTC 
Confusingly, the symbol list in Devhelp lists each class name twice.  For example, if I type "gtkwind" in the search box, the resulting list contains two instances of GtkWindow.  Clicking the first takes me to the main GtkWindow page, which is nice.  Clicking the second takes me to the GtkWindow typedef on that page, i.e. 'typedef struct _GtkWindow GtkWindow;', which isn't terribly useful.

I think it would be nicer if Devhelp only showed the first of these.  If it must show both, it would be nice if they were differentiated in the symbol list, e.g. the second could appear as 'GtkWindow (typedef)'.
Comment 1 Aleksander Morgado 2013-03-30 15:22:41 UTC 
Hiding result items is not a good idea. For the specific case of the GtkWindow, listing the typedef is not useful, but that is just a single case (actually, that's the case for most objects in gtk+, but anyway, not generic enough).

Instead, I think we should try to give more info in each result of the list. In addition to the symbol name, we could also specify the type of result (e.g. 'section' or 'type'), or also even the book name, e.g.:

Search "gtkwindow"

  GtkWindow  |  section  | gtk+
  GtkWindow  |  type     | gtk+
  ...
Comment 2 Aleksander Morgado 2013-03-30 15:23:38 UTC 
Marking as ui-review so that designers can comment.
Comment 3 Sébastien Wilmet 2015-05-30 19:33:19 UTC 
I'm not a designer, but I would add the symbol type in parenthesis, a bit smaller and/or in gray, but only for the symbols present with several occurrences. For the symbols present only once, don't add anything, the symbol name is enough.

Instead of parenthesis, another way is to separate the symbol name from the symbol type with a dash.

This would be useful for signal names too, for example "insert-text" or "changed" (there are several occurrences of them in GTK+).
Comment 4 Frederic Peters 2016-01-27 14:38:55 UTC 
I have now added "(type)" in italic and normal weight after structures, signals and properties.

commit 50bcab241b524b5b6a84082598f09aabb196f84d
Author: Frédéric Péters <fpeters@0d.be>
Date:   Wed Jan 27 15:34:50 2016 +0100

    sidebar: include link type in parentheses (for some types)
    
    https://bugzilla.gnome.org/show_bug.cgi?id=696904