pidgin/pidgin

Fix up the docs for PidginBuddyListMenu and PidginPluginsMenu.

2020-03-31, Gary Kramlich
be51a9f44cea
Parents 3e78021f32b2
Children 9713b0ef6504
Fix up the docs for PidginBuddyListMenu and PidginPluginsMenu.
3 files changed, 27 insertions(+), 1 deletions(-)
  • +2 -0
    doc/reference/pidgin/pidgin-docs.xml
  • +10 -0
    pidgin/pidginbuddylistmenu.h
  • +15 -1
    pidgin/pidginpluginsmenu.h
    • --- a/doc/reference/pidgin/pidgin-docs.xml Tue Mar 31 23:45:35 2020 -0500
    +++ b/doc/reference/pidgin/pidgin-docs.xml Tue Mar 31 23:54:24 2020 -0500
    @@ -56,6 +56,7 @@
    <xi:include href="xml/pidgin.xml" />
    <xi:include href="xml/pidginabout.xml" />
    <xi:include href="xml/pidginaccountchooser.xml" />
    + <xi:include href="xml/pidginbuddylistmenu.xml" />
    <xi:include href="xml/pidgincontactcompletion.xml" />
    <xi:include href="xml/pidgindebug.xml" />
    <xi:include href="xml/pidgingdkpixbuf.xml" />
    @@ -66,6 +67,7 @@
    <xi:include href="xml/pidginmessage.xml" />
    <xi:include href="xml/pidginplugininfo.xml" />
    <xi:include href="xml/pidginpluginsdialog.xml" />
    + <xi:include href="xml/pidginpluginsmenu.xml" />
    <xi:include href="xml/pidginstock.xml" />
    <xi:include href="xml/pidgintalkatu.xml" />
    <xi:include href="xml/pidgintooltip.xml" />
    --- a/pidgin/pidginbuddylistmenu.h Tue Mar 31 23:45:35 2020 -0500
    +++ b/pidgin/pidginbuddylistmenu.h Tue Mar 31 23:54:24 2020 -0500
    @@ -22,6 +22,16 @@
    #ifndef PIDGIN_BUDDY_LIST_MENU_H
    #define PIDGIN_BUDDY_LIST_MENU_H
    +/**
    + * SECTION:pidginbuddylistmenu
    + * @section_id: pidgin-buddylist-menu
    + * @short_description: A widget to display the menubar in the buddy list window.
    + * @title: Buddylist Menu
    + *
    + * #PidginBuddyListMenu is a transitional widget as we slowly migrate the
    + * buddylist window to glade.
    + */
    +
    #include <glib.h>
    #include <gtk/gtk.h>
    --- a/pidgin/pidginpluginsmenu.h Tue Mar 31 23:45:35 2020 -0500
    +++ b/pidgin/pidginpluginsmenu.h Tue Mar 31 23:54:24 2020 -0500
    @@ -22,6 +22,20 @@
    #ifndef PIDGIN_PLUGINS_MENU_H
    #define PIDGIN_PLUGINS_MENU_H
    +/**
    + * SECTION:pidginpluginsmenu
    + * @section_id: pidgin-plugins-menu
    + * @short_description: A menu for managing plugins and their actions
    + * @title: Plugins Menu
    + *
    + * #PidginPluginsMenu is a #GtkMenu that provides an interface to users to open
    + * the plugin manager as well as activate plugin actions.
    + *
    + * It manages itself as plugins are loaded and unloaded and can be added as a
    + * submenu to any #GtkMenuItem.
    + */
    +
    +
    #include <gtk/gtk.h>
    G_BEGIN_DECLS
    @@ -31,7 +45,7 @@
    PLUGINS_MENU, GtkMenu)
    /**
    - * pidgin_action_group_new:
    + * pidgin_plugins_menu_new:
    *
    * Creates a new #PidginPluginsMenu instance that keeps itself up to date.
    *