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 708152 - docs: bloatpad.c's GMenu uses submenu-action without explanation
docs: bloatpad.c's GMenu uses submenu-action without explanation
Status: RESOLVED OBSOLETE
Product: glib
Classification: Platform
Component: gio
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2013-09-16 11:37 UTC by Murray Cumming
Modified: 2018-05-24 15:41 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Murray Cumming 2013-09-16 11:37:36 UTC 
bloat_pad_startup() uses a submenu-action attribute in its time-menu submenu:
https://git.gnome.org/browse/gtk+/tree/examples/bloatpad.c#n394

I cannot find any explanation for this in GMenu, GAction, or GtkBuilder's documentation. I guess it should be documented and that a comment in bloatpad.c could give a hint about why it is there.
Comment 1 Allison Karlitskaya (desrt) 2013-09-16 17:31:33 UTC 
see https://wiki.gnome.org/GApplication/GMenuModel
Comment 2 Murray Cumming 2013-09-17 10:29:02 UTC 
OK. Thanks.

In general, I just can't get on board easily with putting documentation in the wiki instead of the API reference. That page is also lacking some context - I can't tell if it's talking about some "attributes and links" in GMenuModel's API (if so, which API exactly), in its internals, or in the XML format used for GMenuModel with GtkBuilder.

Anyway, from "Defined on submenu items, this attribute names an action used to signal when the submenu is shown or not" this seems to be a way to detect showing and hiding of the submenu, so you can update its contents. That sentence is ambiguous, so at first I thought it was a way to _control_ when the menu is shown. I'm afraid the rest of the text is rather hard to read too.

Is there an appropriate place to mention this in the API docs, such as in the GtkBuilder API docs?
Comment 3 Matthias Clasen 2016-05-24 00:58:09 UTC 
I don't think the GtkBuilder docs are the right place for this. If the wiki is not good enough, please submit a patch to add the information from there to the GMenuModel docs.
Comment 4 GNOME Infrastructure Team 2018-05-24 15:41:45 UTC 
-- GitLab Migration Automatic Message --

This bug has been migrated to GNOME's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.gnome.org/GNOME/glib/issues/758.