diff options
author | Ted Gould <ted@gould.cx> | 2011-01-27 08:48:37 -0600 |
---|---|---|
committer | Ted Gould <ted@gould.cx> | 2011-01-27 08:48:37 -0600 |
commit | 7e55758aa584a9e4080411cbd663d1fa30725a57 (patch) | |
tree | 5131b62f85c14d86b21485509cf10cf0530bdf69 /libdbusmenu-gtk | |
parent | c6da3667cae61d1606eb66e6b7be01c2cbf9cbff (diff) | |
download | libdbusmenu-7e55758aa584a9e4080411cbd663d1fa30725a57.tar.gz libdbusmenu-7e55758aa584a9e4080411cbd663d1fa30725a57.tar.bz2 libdbusmenu-7e55758aa584a9e4080411cbd663d1fa30725a57.zip |
Adding documentation of the public API.
Diffstat (limited to 'libdbusmenu-gtk')
-rw-r--r-- | libdbusmenu-gtk/parser.c | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/libdbusmenu-gtk/parser.c b/libdbusmenu-gtk/parser.c index 5dea9de..8537a07 100644 --- a/libdbusmenu-gtk/parser.c +++ b/libdbusmenu-gtk/parser.c @@ -67,7 +67,17 @@ static void menuitem_notify_cb (GtkWidget * widget, GParamSpec * pspec, gpointer data); +/** + dbusmenu_gtk_parse_menu_structure: + @widget: A #GtkMenuItem or #GtkMenuShell to turn into a #DbusmenuMenuitem + Goes through the GTK structures and turns them into the appropraite + Dbusmenu structures along with setting up all the relationships + between the objects. It also stores the dbusmenu items as a cache + on the GTK items so that they'll be reused if necissary. + + Return value: A dbusmenu item representing the menu structure +*/ DbusmenuMenuitem * dbusmenu_gtk_parse_menu_structure (GtkWidget * widget) { |