diff options
Diffstat (limited to 'docs/libdbusmenu-glib')
| -rw-r--r-- | docs/libdbusmenu-glib/Makefile.am | 1 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/Makefile.am | 92 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml | 33 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt | 157 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/tmpl/dummy.sgml | 0 | ||||
| -rw-r--r-- | docs/libdbusmenu-glib/reference/version.xml.in | 1 |
6 files changed, 284 insertions, 0 deletions
diff --git a/docs/libdbusmenu-glib/Makefile.am b/docs/libdbusmenu-glib/Makefile.am new file mode 100644 index 0000000..f3ddc22 --- /dev/null +++ b/docs/libdbusmenu-glib/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = reference diff --git a/docs/libdbusmenu-glib/reference/Makefile.am b/docs/libdbusmenu-glib/reference/Makefile.am new file mode 100644 index 0000000..e8a3610 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/Makefile.am @@ -0,0 +1,92 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libdbusmenu-glib + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=../../../libdbusmenu-glib + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS=--nogtkinit --type-init-func="g_type_init()" + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/libdbusmenu-glib/*.h +CFILE_GLOB=$(top_srcdir)/libdbusmenu-glib/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= \ + menuitem-marshal.h \ + server-marshal.h \ + menuitem-private.h \ + dbusmenu-client.h \ + dbusmenu-server.h + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files=version.xml + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +INCLUDES=-I$(top_srcdir) $(DBUSMENUGLIB_CFLAGS) $(DBUSMENUGTK_CFLAGS) +GTKDOC_LIBS=$(top_builddir)/libdbusmenu-glib/libdbusmenu-glib.la + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.local.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in + +# Files not to distribute +# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types +# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt +#DISTCLEANFILES += + +# Comment this out if you want your docs-status tested during 'make check' +#TESTS = $(GTKDOC_CHECK) + diff --git a/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml new file mode 100644 index 0000000..ecc25a3 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml @@ -0,0 +1,33 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<book id="index"> + <bookinfo> + <title>libdbusmenu-glib Reference Manual</title> + </bookinfo> + + <chapter> + <title>API</title> + <xi:include href="xml/server.xml"/> + <xi:include href="xml/menuitem-proxy.xml"/> + <xi:include href="xml/menuitem.xml"/> + <xi:include href="xml/client.xml"/> + <xi:include href="xml/client-menuitem.xml"/> + <xi:include href="xml/dbusmenu-client.xml"/> + <xi:include href="xml/dbusmenu-server.xml"/> + + </chapter> + <chapter id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + <index id="api-index-full"> + <title>API Index</title> + <xi:include href="xml/api-index-full.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 new file mode 100644 index 0000000..0186049 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt @@ -0,0 +1,157 @@ +<SECTION> +<FILE>client</FILE> +<TITLE>DbusmenuClient</TITLE> +DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED +DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED +DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM +DBUSMENU_CLIENT_PROP_DBUS_NAME +DBUSMENU_CLIENT_PROP_DBUS_OBJECT +DBUSMENU_CLIENT_TYPES_DEFAULT +DBUSMENU_CLIENT_TYPES_SEPARATOR +DBUSMENU_CLIENT_TYPES_IMAGE +DbusmenuClient +DbusmenuClientClass +DbusmenuClientTypeHandler +dbusmenu_client_new +dbusmenu_client_get_root +dbusmenu_client_add_type_handler +dbusmenu_client_send_event +dbusmenu_client_send_about_to_show +<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 +</SECTION> + +<SECTION> +<FILE>menuitem</FILE> +<TITLE>DbusmenuMenuitem</TITLE> +DBUSMENU_MENUITEM_SIGNAL_PROPERTY_CHANGED +DBUSMENU_MENUITEM_SIGNAL_ITEM_ACTIVATED +DBUSMENU_MENUITEM_SIGNAL_CHILD_ADDED +DBUSMENU_MENUITEM_SIGNAL_CHILD_REMOVED +DBUSMENU_MENUITEM_SIGNAL_CHILD_MOVED +DBUSMENU_MENUITEM_SIGNAL_REALIZED +DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID +DBUSMENU_MENUITEM_PROP_TYPE +DBUSMENU_MENUITEM_PROP_VISIBLE +DBUSMENU_MENUITEM_PROP_ENABLED +DBUSMENU_MENUITEM_PROP_LABEL +DBUSMENU_MENUITEM_PROP_ICON_NAME +DBUSMENU_MENUITEM_PROP_ICON_DATA +DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE +DBUSMENU_MENUITEM_PROP_TOGGLE_STATE +DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY +DBUSMENU_MENUITEM_TOGGLE_CHECK +DBUSMENU_MENUITEM_TOGGLE_RADIO +DBUSMENU_MENUITEM_TOGGLE_STATE_UNCHECKED +DBUSMENU_MENUITEM_TOGGLE_STATE_CHECKED +DBUSMENU_MENUITEM_TOGGLE_STATE_UNKNOWN +DBUSMENU_MENUITEM_ICON_NAME_BLANK +DBUSMENU_MENUITEM_CHILD_DISPLAY_SUBMENU +DbusmenuMenuitem +dbusmenu_menuitem_about_to_show_cb +dbusmenu_menuitem_buildxml_slot_t +DbusmenuMenuitemClass +dbusmenu_menuitem_new +dbusmenu_menuitem_new_with_id +dbusmenu_menuitem_get_id +dbusmenu_menuitem_get_children +dbusmenu_menuitem_take_children +dbusmenu_menuitem_get_position +dbusmenu_menuitem_get_position_realized +dbusmenu_menuitem_child_append +dbusmenu_menuitem_child_prepend +dbusmenu_menuitem_child_delete +dbusmenu_menuitem_child_add_position +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_get +dbusmenu_menuitem_property_get_value +dbusmenu_menuitem_property_get_bool +dbusmenu_menuitem_property_get_int +dbusmenu_menuitem_property_exist +dbusmenu_menuitem_properties_list +dbusmenu_menuitem_properties_copy +dbusmenu_menuitem_property_remove +dbusmenu_menuitem_set_root +dbusmenu_menuitem_get_root +dbusmenu_menuitem_foreach +dbusmenu_menuitem_handle_event +dbusmenu_menuitem_send_about_to_show +<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 +</SECTION> + +<SECTION> +<FILE>server</FILE> +<TITLE>DbusmenuServer</TITLE> +DBUSMENU_SERVER_SIGNAL_ID_PROP_UPDATE +DBUSMENU_SERVER_SIGNAL_ID_UPDATE +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATED +DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE +DBUSMENU_SERVER_PROP_DBUS_OBJECT +DBUSMENU_SERVER_PROP_ROOT_NODE +DBUSMENU_SERVER_PROP_VERSION +DbusmenuServer +DbusmenuServerClass +dbusmenu_server_new +dbusmenu_server_set_root +<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 +</SECTION> + +<SECTION> +<FILE>menuitem-proxy</FILE> +<TITLE>DbusmenuMenuitemProxy</TITLE> +DbusmenuMenuitemProxy +DbusmenuMenuitemProxyClass +dbusmenu_menuitem_proxy_new +dbusmenu_menuitem_proxy_get_wrapped +<SUBSECTION Standard> +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 +</SECTION> + diff --git a/docs/libdbusmenu-glib/reference/tmpl/dummy.sgml b/docs/libdbusmenu-glib/reference/tmpl/dummy.sgml new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/tmpl/dummy.sgml diff --git a/docs/libdbusmenu-glib/reference/version.xml.in b/docs/libdbusmenu-glib/reference/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/docs/libdbusmenu-glib/reference/version.xml.in @@ -0,0 +1 @@ +@VERSION@ |