diff options
author | Ted Gould <ted@canonical.com> | 2009-08-18 13:41:27 -0500 |
---|---|---|
committer | Ted Gould <ted@canonical.com> | 2009-08-18 13:41:27 -0500 |
commit | f9bc0fe67b49f00732073c5945d8dd50d60ecb97 (patch) | |
tree | 55cc90563a8a798ecbae07d3f441dafea247237e /docs/reference | |
parent | dcbb7eba056da11cf575bb2a10fea954440bb0fb (diff) | |
parent | ba24704988964a1f211e82e87cbe8aca29641979 (diff) | |
download | libayatana-indicator-f9bc0fe67b49f00732073c5945d8dd50d60ecb97.tar.gz libayatana-indicator-f9bc0fe67b49f00732073c5945d8dd50d60ecb97.tar.bz2 libayatana-indicator-f9bc0fe67b49f00732073c5945d8dd50d60ecb97.zip |
Merging in the separation from indicator-applet
Diffstat (limited to 'docs/reference')
-rw-r--r-- | docs/reference/Makefile.am | 87 | ||||
-rw-r--r-- | docs/reference/libindicate-docs.sgml | 32 | ||||
-rw-r--r-- | docs/reference/libindicate-sections.txt | 63 | ||||
-rw-r--r-- | docs/reference/libindicate.types | 9 | ||||
-rw-r--r-- | docs/reference/tmpl/libindicate-unused.sgml | 655 | ||||
-rw-r--r-- | docs/reference/version.xml.in | 1 |
6 files changed, 0 insertions, 847 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am deleted file mode 100644 index 2589179..0000000 --- a/docs/reference/Makefile.am +++ /dev/null @@ -1,87 +0,0 @@ -## 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=libindicate - -# 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=../../libindicate - -# 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)/libindicate/*.h -CFILE_GLOB=$(top_srcdir)/libindicate/*.c - -# Header files to ignore when scanning. -# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES=dbus-indicate-client.h dbus-indicate-server.h dbus-listener-client.h dbus-listener-server.h listener-marshal.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) $(LIBINDICATE_CFLAGS) -GTKDOC_LIBS=$(top_builddir)/libindicate/libindicate.la - -# This includes the standard gtk-doc make rules, copied by gtkdocize. -include $(top_srcdir)/gtk-doc.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/reference/libindicate-docs.sgml b/docs/reference/libindicate-docs.sgml deleted file mode 100644 index c3038d3..0000000 --- a/docs/reference/libindicate-docs.sgml +++ /dev/null @@ -1,32 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> -<book id="libindicatebook" xmlns:xi="http://www.w3.org/2003/XInclude"> - - <bookinfo> - <title>libindicate Reference Manual</title> - </bookinfo> - -<part id="base"> - <title>Base Classes for Applications</title> - <xi:include href="xml/indicator.xml" /> - <xi:include href="xml/server.xml" /> -</part> - -<part id="subclass"> - <title>Subclasses for specific indicators</title> - <xi:include href="xml/indicator-message.xml" /> -</part> - -<part id="listeners"> - <title>Classes for Listeners</title> - <xi:include href="xml/listener.xml" /> -</part> - -<part id="index"> - <index> - <title>Index of all Symbols</title> - </index> -</part> - -</book> diff --git a/docs/reference/libindicate-sections.txt b/docs/reference/libindicate-sections.txt deleted file mode 100644 index 6e2a8cd..0000000 --- a/docs/reference/libindicate-sections.txt +++ /dev/null @@ -1,63 +0,0 @@ -<INCLUDE>indicator.h</INCLUDE> - -<SECTION> -<FILE>indicator</FILE> -<TITLE>IndicateIndicator</TITLE> -IndicateIndicator -IndicateIndicatorClass -indicate_indicator_get_id -indicate_indicator_get_indicator_type -indicate_indicator_get_property -indicate_indicator_hide -indicate_indicator_is_visible -indicate_indicator_list_properties -indicate_indicator_new -indicate_indicator_set_property -indicate_indicator_set_property_icon -indicate_indicator_set_property_time -indicate_indicator_show -indicate_indicator_user_display -</SECTION> - -<SECTION> -<FILE>indicator-message</FILE> -<TITLE>IndicateIndicatorMessage</TITLE> -IndicateIndicatorMessage -IndicateIndicatorMessageClass -indicate_indicator_message_new -</SECTION> - -<SECTION> -<FILE>server</FILE> -<TITLE>IndicateServer</TITLE> -IndicateServer -IndicateServerClass -indicate_server_add_indicator -indicate_server_check_interest -indicate_server_emit_indicator_added -indicate_server_emit_indicator_modified -indicate_server_emit_indicator_removed -indicate_server_emit_server_display -indicate_server_get_next_id -indicate_server_hide -indicate_server_ref_default -indicate_server_remove_indicator -indicate_server_set_default -indicate_server_set_desktop_file -indicate_server_set_type -indicate_server_show -</SECTION> - -<SECTION> -<FILE>listener</FILE> -<TITLE>IndicateListener</TITLE> -IndicateListener -IndicateListenerClass -IndicateListenerIndicator -IndicateListenerServer -indicate_listener_display -indicate_listener_get_property -indicate_listener_get_property_cb -indicate_listener_new -</SECTION> - diff --git a/docs/reference/libindicate.types b/docs/reference/libindicate.types deleted file mode 100644 index d96055f..0000000 --- a/docs/reference/libindicate.types +++ /dev/null @@ -1,9 +0,0 @@ -#include <libindicate/indicator.h> -#include <libindicate/indicator-message.h> -#include <libindicate/server.h> -#include <libindicate/listener.h> - -indicate_indicator_get_type -indicate_indicator_message_get_type -indicate_server_get_type -indicate_listener_get_type diff --git a/docs/reference/tmpl/libindicate-unused.sgml b/docs/reference/tmpl/libindicate-unused.sgml deleted file mode 100644 index 8f457e2..0000000 --- a/docs/reference/tmpl/libindicate-unused.sgml +++ /dev/null @@ -1,655 +0,0 @@ -<!-- ##### MACRO INDICATE_INDICATOR ##### --> -<para> - -</para> - -@object: - -<!-- ##### MACRO INDICATE_INDICATOR_CLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO INDICATE_INDICATOR_GET_CLASS ##### --> -<para> - -</para> - -@object: - -<!-- ##### MACRO INDICATE_INDICATOR_MESSAGE ##### --> -<para> - -</para> - -@obj: - -<!-- ##### MACRO INDICATE_INDICATOR_MESSAGE_CLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO INDICATE_INDICATOR_MESSAGE_GET_CLASS ##### --> -<para> - -</para> - -@obj: - -<!-- ##### MACRO INDICATE_INDICATOR_SIGNAL_DISPLAY ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_INDICATOR_SIGNAL_HIDE ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_INDICATOR_SIGNAL_MODIFIED ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_INDICATOR_SIGNAL_SHOW ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_IS_INDICATOR ##### --> -<para> - -</para> - -@object: - -<!-- ##### MACRO INDICATE_IS_INDICATOR_CLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO INDICATE_IS_INDICATOR_MESSAGE ##### --> -<para> - -</para> - -@obj: - -<!-- ##### MACRO INDICATE_IS_INDICATOR_MESSAGE_CLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO INDICATE_IS_LISTENER ##### --> -<para> - -</para> - -@object: - -<!-- ##### MACRO INDICATE_IS_LISTENER_CLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO INDICATE_IS_SERVER ##### --> -<para> - -</para> - -@object: - -<!-- ##### MACRO INDICATE_IS_SERVER_CLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO INDICATE_LISTENER ##### --> -<para> - -</para> - -@object: - -<!-- ##### MACRO INDICATE_LISTENER_CLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO INDICATE_LISTENER_GET_CLASS ##### --> -<para> - -</para> - -@object: - -<!-- ##### MACRO INDICATE_LISTENER_INDICATOR_ID ##### --> -<para> - -</para> - -@indicator: - -<!-- ##### MACRO INDICATE_LISTENER_SERVER_DBUS_NAME ##### --> -<para> - -</para> - -@server: - -<!-- ##### MACRO INDICATE_LISTENER_SIGNAL_INDICATOR_ADDED ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_LISTENER_SIGNAL_INDICATOR_MODIFIED ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_LISTENER_SIGNAL_INDICATOR_REMOVED ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_LISTENER_SIGNAL_SERVER_ADDED ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_LISTENER_SIGNAL_SERVER_REMOVED ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_SERVER ##### --> -<para> - -</para> - -@object: - -<!-- ##### MACRO INDICATE_SERVER_CLASS ##### --> -<para> - -</para> - -@klass: - -<!-- ##### MACRO INDICATE_SERVER_GET_CLASS ##### --> -<para> - -</para> - -@object: - -<!-- ##### MACRO INDICATE_TYPE_INDICATOR ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_TYPE_INDICATOR_MESSAGE ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_TYPE_LISTENER ##### --> -<para> - -</para> - - -<!-- ##### MACRO INDICATE_TYPE_SERVER ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION dbus_g_proxy_begin_call ##### --> -<para> - -</para> - -@Param1: -@Returns: - -<!-- ##### MACRO g_marshal_value_peek_boolean ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_boxed ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_char ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_double ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_enum ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_flags ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_float ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_int ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_int64 ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_long ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_object ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_param ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_pointer ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_string ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_uchar ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_uint ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_uint64 ##### --> -<para> - -</para> - -@v: - -<!-- ##### MACRO g_marshal_value_peek_ulong ##### --> -<para> - -</para> - -@v: - -<!-- ##### FUNCTION indicate_indicator_get_type ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION indicate_indicator_message_get_type ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION indicate_indicator_set_property_icon ##### --> -<para> - -</para> - -@indicator: -@key: -@data: - -<!-- ##### FUNCTION indicate_listener_get_type ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION indicate_server_get_type ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION indicate_server_new ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION indicate_server_set_dbus_object ##### --> -<para> - -</para> - -@obj: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_count ##### --> -<para> - -</para> - -@proxy: -@OUT_indicator_count: -@Returns: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_count_async ##### --> -<para> - -</para> - -@proxy: -@callback: -@Returns: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_count_by_type ##### --> -<para> - -</para> - -@proxy: -@IN_type: -@OUT_indicator_count: -@Returns: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_count_by_type_async ##### --> -<para> - -</para> - -@proxy: -@IN_type: -@callback: -@Returns: - -<!-- ##### USER_FUNCTION org_freedesktop_indicator_get_indicator_count_by_type_reply ##### --> -<para> - -</para> - -@proxy: -@OUT_indicator_count: -@error: -@userdata: - -<!-- ##### USER_FUNCTION org_freedesktop_indicator_get_indicator_count_reply ##### --> -<para> - -</para> - -@proxy: -@OUT_indicator_count: -@error: -@userdata: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_list ##### --> -<para> - -</para> - -@proxy: -@OUT_indicators: -@Returns: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_list_async ##### --> -<para> - -</para> - -@proxy: -@callback: -@Returns: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_list_by_type ##### --> -<para> - -</para> - -@proxy: -@IN_type: -@OUT_indicators: -@Returns: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_list_by_type_async ##### --> -<para> - -</para> - -@proxy: -@IN_type: -@callback: -@Returns: - -<!-- ##### USER_FUNCTION org_freedesktop_indicator_get_indicator_list_by_type_reply ##### --> -<para> - -</para> - -@proxy: -@OUT_indicators: -@error: -@userdata: - -<!-- ##### USER_FUNCTION org_freedesktop_indicator_get_indicator_list_reply ##### --> -<para> - -</para> - -@proxy: -@OUT_indicators: -@error: -@userdata: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_properties ##### --> -<para> - -</para> - -@proxy: -@IN_id: -@OUT_properties: -@Returns: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_properties_async ##### --> -<para> - -</para> - -@proxy: -@IN_id: -@callback: -@Returns: - -<!-- ##### USER_FUNCTION org_freedesktop_indicator_get_indicator_properties_reply ##### --> -<para> - -</para> - -@proxy: -@OUT_properties: -@error: -@userdata: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_property ##### --> -<para> - -</para> - -@proxy: -@IN_id: -@IN_property: -@OUT_value: -@Returns: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_property_async ##### --> -<para> - -</para> - -@proxy: -@IN_id: -@IN_property: -@callback: -@Returns: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_property_group ##### --> -<para> - -</para> - -@proxy: -@IN_id: -@IN_properties: -@OUT_values: -@Returns: - -<!-- ##### FUNCTION org_freedesktop_indicator_get_indicator_property_group_async ##### --> -<para> - -</para> - -@proxy: -@IN_id: -@IN_properties: -@callback: -@Returns: - -<!-- ##### USER_FUNCTION org_freedesktop_indicator_get_indicator_property_group_reply ##### --> -<para> - -</para> - -@proxy: -@OUT_values: -@error: -@userdata: - -<!-- ##### USER_FUNCTION org_freedesktop_indicator_get_indicator_property_reply ##### --> -<para> - -</para> - -@proxy: -@OUT_value: -@error: -@userdata: - -<!-- ##### FUNCTION org_freedesktop_indicator_show_indicator_to_user ##### --> -<para> - -</para> - -@proxy: -@IN_id: -@Returns: - -<!-- ##### FUNCTION org_freedesktop_indicator_show_indicator_to_user_async ##### --> -<para> - -</para> - -@proxy: -@IN_id: -@callback: -@Returns: - -<!-- ##### USER_FUNCTION org_freedesktop_indicator_show_indicator_to_user_reply ##### --> -<para> - -</para> - -@proxy: -@error: -@userdata: - diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in deleted file mode 100644 index d78bda9..0000000 --- a/docs/reference/version.xml.in +++ /dev/null @@ -1 +0,0 @@ -@VERSION@ |