diff options
Diffstat (limited to 'docs')
6 files changed, 173 insertions, 33 deletions
diff --git a/docs/libdbusmenu-glib/reference/Makefile.am b/docs/libdbusmenu-glib/reference/Makefile.am index e8a3610..2af5ec3 100644 --- a/docs/libdbusmenu-glib/reference/Makefile.am +++ b/docs/libdbusmenu-glib/reference/Makefile.am @@ -48,11 +48,13 @@ CFILE_GLOB=$(top_srcdir)/libdbusmenu-glib/*.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h IGNORE_HFILES= \ + dbus-menu-clean.xml.h \ + client-menuitem.h \ + client-private.h \ + defaults.h \ menuitem-marshal.h \ server-marshal.h \ - menuitem-private.h \ - dbusmenu-client.h \ - dbusmenu-server.h + menuitem-private.h # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png @@ -88,5 +90,13 @@ EXTRA_DIST += version.xml.in #DISTCLEANFILES += # Comment this out if you want your docs-status tested during 'make check' -#TESTS = $(GTKDOC_CHECK) +TESTS = gtkdoc-in-srcdir + +gtkdoc-in-srcdir: Makefile.am + @echo "#!/bin/sh" > $@ + @echo "cd \"$(srcdir)\"" >> $@ + @echo "$(GTKDOC_CHECK)" >> $@ + @chmod +x $@ + +DISTCLEANFILES = gtkdoc-in-srcdir diff --git a/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml index ecc25a3..53a0ceb 100644 --- a/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml +++ b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml @@ -18,6 +18,7 @@ <xi:include href="xml/client-menuitem.xml"/> <xi:include href="xml/dbusmenu-client.xml"/> <xi:include href="xml/dbusmenu-server.xml"/> + <xi:include href="xml/types.xml"/> </chapter> <chapter id="object-tree"> @@ -28,6 +29,10 @@ <title>API Index</title> <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> </index> + <index id="api-index-deprecated"> + <title>Deprecated API Index</title> + <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> + </index> <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> </book> diff --git a/docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt index 0186049..b1e2d8c 100644 --- a/docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt +++ b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt @@ -4,27 +4,36 @@ DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM +DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT +DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE +DBUSMENU_CLIENT_SIGNAL_TEXT_DIRECTION_CHANGED DBUSMENU_CLIENT_PROP_DBUS_NAME DBUSMENU_CLIENT_PROP_DBUS_OBJECT +DBUSMENU_CLIENT_PROP_STATUS +DBUSMENU_CLIENT_PROP_TEXT_DIRECTION DBUSMENU_CLIENT_TYPES_DEFAULT DBUSMENU_CLIENT_TYPES_SEPARATOR DBUSMENU_CLIENT_TYPES_IMAGE DbusmenuClient DbusmenuClientClass DbusmenuClientTypeHandler +DbusmenuClientTypeDestroyHandler dbusmenu_client_new dbusmenu_client_get_root +dbusmenu_client_get_status +dbusmenu_client_get_text_direction dbusmenu_client_add_type_handler -dbusmenu_client_send_event -dbusmenu_client_send_about_to_show +dbusmenu_client_add_type_handler_full <SUBSECTION Standard> DBUSMENU_CLIENT DBUSMENU_IS_CLIENT DBUSMENU_TYPE_CLIENT -dbusmenu_client_get_type DBUSMENU_CLIENT_CLASS DBUSMENU_IS_CLIENT_CLASS DBUSMENU_CLIENT_GET_CLASS +<SUBSECTION Private> +DbusmenuClientPrivate +dbusmenu_client_get_type </SECTION> <SECTION> @@ -35,8 +44,11 @@ DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED +DBUSMENU_MENUITEM_SIGNAL_EVENT DBUSMENU_MENUITEM_SIGNAL_REALIZED DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID +DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW +DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER DBUSMENU_MENUITEM_PROP_TYPE DBUSMENU_MENUITEM_PROP_VISIBLE DBUSMENU_MENUITEM_PROP_ENABLED @@ -46,6 +58,7 @@ DBUSMENU_MENUITEM_PROP_ICON_DATA DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE DBUSMENU_MENUITEM_PROP_TOGGLE_STATE DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY +DBUSMENU_MENUITEM_PROP_SHORTCUT DBUSMENU_MENUITEM_TOGGLE_CHECK DBUSMENU_MENUITEM_TOGGLE_RADIO DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED @@ -53,9 +66,13 @@ DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN DBUSMENU_MENUITEM_ICON_NAME_BLANK DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU +DBUSMENU_MENUITEM_SHORTCUT_ALT +DBUSMENU_MENUITEM_SHORTCUT_CONTROL +DBUSMENU_MENUITEM_SHORTCUT_SHIFT +DBUSMENU_MENUITEM_SHORTCUT_SUPER DbusmenuMenuitem dbusmenu_menuitem_about_to_show_cb -dbusmenu_menuitem_buildxml_slot_t +dbusmenu_menuitem_buildvariant_slot_t DbusmenuMenuitemClass dbusmenu_menuitem_new dbusmenu_menuitem_new_with_id @@ -72,13 +89,13 @@ dbusmenu_menuitem_child_reorder dbusmenu_menuitem_child_find dbusmenu_menuitem_find_id dbusmenu_menuitem_property_set -dbusmenu_menuitem_property_set_value dbusmenu_menuitem_property_set_bool dbusmenu_menuitem_property_set_int +dbusmenu_menuitem_property_set_variant dbusmenu_menuitem_property_get -dbusmenu_menuitem_property_get_value dbusmenu_menuitem_property_get_bool dbusmenu_menuitem_property_get_int +dbusmenu_menuitem_property_get_variant dbusmenu_menuitem_property_exist dbusmenu_menuitem_properties_list dbusmenu_menuitem_properties_copy @@ -88,14 +105,20 @@ dbusmenu_menuitem_get_root dbusmenu_menuitem_foreach dbusmenu_menuitem_handle_event dbusmenu_menuitem_send_about_to_show +dbusmenu_menuitem_show_to_user +dbusmenu_menuitem_get_parent +dbusmenu_menuitem_set_parent +dbusmenu_menuitem_unparent <SUBSECTION Standard> DBUSMENU_MENUITEM DBUSMENU_IS_MENUITEM DBUSMENU_TYPE_MENUITEM -dbusmenu_menuitem_get_type DBUSMENU_MENUITEM_CLASS DBUSMENU_IS_MENUITEM_CLASS DBUSMENU_MENUITEM_GET_CLASS +<SUBSECTION Private> +DbusmenuMenuitemPrivate +dbusmenu_menuitem_get_type </SECTION> <SECTION> @@ -105,37 +128,30 @@ DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE DBUSMENU_SERVER_SIGNAL_ID_UPDATE DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE +DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION DBUSMENU_SERVER_PROP_DBUS_OBJECT DBUSMENU_SERVER_PROP_ROOT_NODE +DBUSMENU_SERVER_PROP_STATUS +DBUSMENU_SERVER_PROP_TEXT_DIRECTION DBUSMENU_SERVER_PROP_VERSION DbusmenuServer DbusmenuServerClass dbusmenu_server_new +dbusmenu_server_get_status +dbusmenu_server_get_text_direction dbusmenu_server_set_root +dbusmenu_server_set_status +dbusmenu_server_set_text_direction <SUBSECTION Standard> DBUSMENU_SERVER DBUSMENU_IS_SERVER DBUSMENU_TYPE_SERVER -dbusmenu_server_get_type DBUSMENU_SERVER_CLASS DBUSMENU_IS_SERVER_CLASS DBUSMENU_SERVER_GET_CLASS -</SECTION> - -<SECTION> -<FILE>client-menuitem</FILE> -<TITLE>DbusmenuClientMenuitem</TITLE> -DBUSMENU_CLIENT_MENUITEM_TYPE -DbusmenuClientMenuitem -DbusmenuClientMenuitemClass -dbusmenu_client_menuitem_new -<SUBSECTION Standard> -DBUSMENU_CLIENT_MENUITEM -DBUSMENU_IS_CLIENT_MENUITEM -dbusmenu_client_menuitem_get_type -DBUSMENU_CLIENT_MENUITEM_CLASS -DBUSMENU_IS_CLIENT_MENUITEM_CLASS -DBUSMENU_CLIENT_MENUITEM_GET_CLASS +<SUBSECTION Private> +DbusmenuServerPrivate +dbusmenu_server_get_type </SECTION> <SECTION> @@ -149,9 +165,29 @@ dbusmenu_menuitem_proxy_get_wrapped DBUSMENU_MENUITEM_PROXY DBUSMENU_IS_MENUITEM_PROXY DBUSMENU_TYPE_MENUITEM_PROXY -dbusmenu_menuitem_proxy_get_type DBUSMENU_MENUITEM_PROXY_CLASS DBUSMENU_IS_MENUITEM_PROXY_CLASS DBUSMENU_MENUITEM_PROXY_GET_CLASS +<SUBSECTION Private> +DbusmenuMenuitemProxyPrivate +dbusmenu_menuitem_proxy_get_type +</SECTION> + +<SECTION> +<FILE>types</FILE> +<TITLE>Types</TITLE> +DBUSMENU_TYPE_STATUS +DBUSMENU_TYPE_TEXT_DIRECTION +DbusmenuStatus +DbusmenuTextDirection +dbusmenu_status_get_nick +dbusmenu_status_get_type +dbusmenu_status_get_value_from_nick +dbusmenu_text_direction_get_nick +dbusmenu_text_direction_get_type +dbusmenu_text_direction_get_value_from_nick +<SUBSECTION Private> +DbusmenuServerPrivate +dbusmenu_server_get_type </SECTION> diff --git a/docs/libdbusmenu-gtk/reference/Makefile.am b/docs/libdbusmenu-gtk/reference/Makefile.am index 191d68e..06d0009 100644 --- a/docs/libdbusmenu-gtk/reference/Makefile.am +++ b/docs/libdbusmenu-gtk/reference/Makefile.am @@ -16,7 +16,7 @@ AUTOMAKE_OPTIONS = 1.6 # of using the various options. # The name of the module, e.g. 'glib'. -DOC_MODULE=libdbusmenu-gtk$(VER) +DOC_MODULE=libdbusmenu-gtk # The top-level SGML file. You can change this if you want to. DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml @@ -90,5 +90,12 @@ EXTRA_DIST += version.xml.in #DISTCLEANFILES += # Comment this out if you want your docs-status tested during 'make check' -#TESTS = $(GTKDOC_CHECK) +TESTS = gtkdoc-in-srcdir +gtkdoc-in-srcdir: Makefile.am + @echo "#!/bin/sh" > $@ + @echo "cd \"$(srcdir)\"" >> $@ + @echo "$(GTKDOC_CHECK)" >> $@ + @chmod +x $@ + +DISTCLEANFILES = gtkdoc-in-srcdir diff --git a/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-docs.sgml b/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-docs.sgml index ec6b82f..e9020de 100644 --- a/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-docs.sgml +++ b/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-docs.sgml @@ -11,9 +11,10 @@ <chapter> <title>API</title> - <xi:include href="xml/menu.xml"/> - <xi:include href="xml/client.xml"/> + <xi:include href="xml/menu.xml"/> <xi:include href="xml/menuitem.xml"/> + <xi:include href="xml/client.xml"/> + <xi:include href="xml/parser.xml"/> <xi:include href="xml/serializablemenuitem.xml"/> </chapter> @@ -25,6 +26,10 @@ <title>API Index</title> <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> </index> + <index id="api-index-deprecated"> + <title>Deprecated API Index</title> + <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> + </index> <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> </book> diff --git a/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-sections.txt b/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-sections.txt new file mode 100644 index 0000000..77101f7 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/libdbusmenu-gtk-sections.txt @@ -0,0 +1,77 @@ +<SECTION> +<FILE>client</FILE> +<TITLE>DbusmenuGtkClient</TITLE> +DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED +DbusmenuGtkClient +DbusmenuGtkClientClass +dbusmenu_gtkclient_new +dbusmenu_gtkclient_menuitem_get +dbusmenu_gtkclient_menuitem_get_submenu +dbusmenu_gtkclient_set_accel_group +dbusmenu_gtkclient_get_accel_group +dbusmenu_gtkclient_newitem_base +<SUBSECTION Standard> +DBUSMENU_GTKCLIENT +DBUSMENU_IS_GTKCLIENT +DBUSMENU_GTKCLIENT_CLASS +DBUSMENU_IS_GTKCLIENT_CLASS +DBUSMENU_GTKCLIENT_GET_CLASS +<SUBSECTION Private> +DBUSMENU_GTKCLIENT_TYPE +dbusmenu_gtkclient_get_type +DbusmenuGtkClientPrivate +</SECTION> + +<SECTION> +<FILE>serializablemenuitem</FILE> +<TITLE>DbusmenuGtkSerializableMenuItem</TITLE> +DBUSMENU_GTK_SERIALIZABLE_MENU_ITEM_PROP_MENUITEM +DbusmenuGtkSerializableMenuItemClass +dbusmenu_gtk_serializable_menu_item_build_menuitem +dbusmenu_gtk_serializable_menu_item_register_to_client +dbusmenu_gtk_serializable_menu_item_set_menuitem +<SUBSECTION Standard> +DBUSMENU_GTK_SERIALIZABLE_MENU_ITEM +DBUSMENU_IS_GTK_SERIALIZABLE_MENU_ITEM +DBUSMENU_GTK_SERIALIZABLE_MENU_ITEM_CLASS +DBUSMENU_IS_GTK_SERIALIZABLE_MENU_ITEM_CLASS +DBUSMENU_GTK_SERIALIZABLE_MENU_ITEM_GET_CLASS +<SUBSECTION Private> +DBUSMENU_TYPE_GTK_SERIALIZABLE_MENU_ITEM +dbusmenu_gtk_serializable_menu_item_get_type +DbusmenuGtkSerializableMenuItemPrivate +</SECTION> + +<SECTION> +<FILE>menu</FILE> +<TITLE>DbusmenuGtkMenu</TITLE> +DbusmenuGtkMenuClass +dbusmenu_gtkmenu_new +dbusmenu_gtkmenu_get_client +<SUBSECTION Standard> +DBUSMENU_GTKMENU +DBUSMENU_IS_GTKMENU +DBUSMENU_GTKMENU_CLASS +DBUSMENU_IS_GTKMENU_CLASS +DBUSMENU_GTKMENU_GET_CLASS +<SUBSECTION Private> +dbusmenu_gtkmenu_get_type +DBUSMENU_GTKMENU_TYPE +DbusmenuGtkMenuPrivate +</SECTION> + +<SECTION> +<FILE>menuitem</FILE> +dbusmenu_menuitem_property_set_image +dbusmenu_menuitem_property_get_image +dbusmenu_menuitem_property_set_shortcut +dbusmenu_menuitem_property_set_shortcut_string +dbusmenu_menuitem_property_set_shortcut_menuitem +dbusmenu_menuitem_property_get_shortcut +</SECTION> + +<SECTION> +<FILE>parser</FILE> +dbusmenu_gtk_parse_menu_structure +</SECTION> + |