aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTed Gould <ted@canonical.com>2009-05-05 16:45:01 +0100
committerTed Gould <ted@canonical.com>2009-05-05 16:45:01 +0100
commite38da9b08cff148bfe85fc29d1188d8b1fd9448c (patch)
tree32e26b6b2054bba366d913ebd5ac7f61d0df88ef /docs
parentf6767c860ee574c964bc7b9bc74affda52f941a1 (diff)
parent7926d56f4dc89d8f30b0f6759119b8dd1507d666 (diff)
downloadlibayatana-indicator-e38da9b08cff148bfe85fc29d1188d8b1fd9448c.tar.gz
libayatana-indicator-e38da9b08cff148bfe85fc29d1188d8b1fd9448c.tar.bz2
libayatana-indicator-e38da9b08cff148bfe85fc29d1188d8b1fd9448c.zip
Merge from upstream, includes documentation.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/Makefile.am2
-rw-r--r--docs/reference/libindicate-docs.sgml34
-rw-r--r--docs/reference/libindicate-sections.txt154
-rw-r--r--docs/reference/tmpl/libindicate-unused.sgml187
4 files changed, 59 insertions, 318 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 759465e..2589179 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -47,7 +47,7 @@ CFILE_GLOB=$(top_srcdir)/libindicate/*.c
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=
+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
diff --git a/docs/reference/libindicate-docs.sgml b/docs/reference/libindicate-docs.sgml
index 0f1ccd1..c3038d3 100644
--- a/docs/reference/libindicate-docs.sgml
+++ b/docs/reference/libindicate-docs.sgml
@@ -1,24 +1,32 @@
<?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="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+<book id="libindicatebook" xmlns:xi="http://www.w3.org/2003/XInclude">
+
<bookinfo>
<title>libindicate Reference Manual</title>
- <releaseinfo>
- for libindicate [VERSION]
- The latest version of this documentation can be found on-line at
- <ulink role="online-location" url="http://[SERVER]/libindicate/index.html">http://[SERVER]/libindicate/</ulink>.
- </releaseinfo>
</bookinfo>
- <chapter>
- <title>[Insert title here]</title>
- </chapter>
+<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>
- <chapter>
- <title>libindicate Indicator</title>
- <xi:include href="xml/indicator.xml" />
- </chapter>
+<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
index f5f3290..6e2a8cd 100644
--- a/docs/reference/libindicate-sections.txt
+++ b/docs/reference/libindicate-sections.txt
@@ -2,148 +2,62 @@
<SECTION>
<FILE>indicator</FILE>
-<TITLE>Everything</TITLE>
-
-INDICATE_INDICATOR
-INDICATE_INDICATOR_CLASS
-INDICATE_INDICATOR_GET_CLASS
-INDICATE_INDICATOR_MESSAGE
-INDICATE_INDICATOR_MESSAGE_CLASS
-INDICATE_INDICATOR_MESSAGE_GET_CLASS
-INDICATE_INDICATOR_SIGNAL_DISPLAY
-INDICATE_INDICATOR_SIGNAL_HIDE
-INDICATE_INDICATOR_SIGNAL_MODIFIED
-INDICATE_INDICATOR_SIGNAL_SHOW
-INDICATE_IS_INDICATOR
-INDICATE_IS_INDICATOR_CLASS
-INDICATE_IS_INDICATOR_MESSAGE
-INDICATE_IS_INDICATOR_MESSAGE_CLASS
-INDICATE_IS_LISTENER
-INDICATE_IS_LISTENER_CLASS
-INDICATE_IS_SERVER
-INDICATE_IS_SERVER_CLASS
-INDICATE_LISTENER
-INDICATE_LISTENER_CLASS
-INDICATE_LISTENER_GET_CLASS
-INDICATE_LISTENER_INDICATOR_ID
-INDICATE_LISTENER_SERVER_DBUS_NAME
-INDICATE_LISTENER_SIGNAL_INDICATOR_ADDED
-INDICATE_LISTENER_SIGNAL_INDICATOR_MODIFIED
-INDICATE_LISTENER_SIGNAL_INDICATOR_REMOVED
-INDICATE_LISTENER_SIGNAL_SERVER_ADDED
-INDICATE_LISTENER_SIGNAL_SERVER_REMOVED
-INDICATE_SERVER
-INDICATE_SERVER_CLASS
-INDICATE_SERVER_GET_CLASS
-INDICATE_TYPE_INDICATOR
-INDICATE_TYPE_INDICATOR_MESSAGE
-INDICATE_TYPE_LISTENER
-INDICATE_TYPE_SERVER
+<TITLE>IndicateIndicator</TITLE>
IndicateIndicator
IndicateIndicatorClass
-IndicateIndicatorMessage
-IndicateIndicatorMessageClass
-IndicateListener
-IndicateListenerClass
-IndicateListenerIndicator
-IndicateListenerServer
-IndicateServer
-IndicateServerClass
-dbus_g_proxy_begin_call
-dbus_glib_marshal_indicate_server_BOOLEAN__POINTER_POINTER
-dbus_glib_marshal_indicate_server_BOOLEAN__STRING_POINTER_POINTER
-dbus_glib_marshal_indicate_server_BOOLEAN__UINT_BOXED_POINTER_POINTER
-dbus_glib_marshal_indicate_server_BOOLEAN__UINT_POINTER
-dbus_glib_marshal_indicate_server_BOOLEAN__UINT_POINTER_POINTER
-dbus_glib_marshal_indicate_server_BOOLEAN__UINT_STRING_POINTER_POINTER
-g_marshal_value_peek_boolean
-g_marshal_value_peek_boxed
-g_marshal_value_peek_char
-g_marshal_value_peek_double
-g_marshal_value_peek_enum
-g_marshal_value_peek_flags
-g_marshal_value_peek_float
-g_marshal_value_peek_int
-g_marshal_value_peek_int64
-g_marshal_value_peek_long
-g_marshal_value_peek_object
-g_marshal_value_peek_param
-g_marshal_value_peek_pointer
-g_marshal_value_peek_string
-g_marshal_value_peek_uchar
-g_marshal_value_peek_uint
-g_marshal_value_peek_uint64
-g_marshal_value_peek_ulong
indicate_indicator_get_id
indicate_indicator_get_indicator_type
indicate_indicator_get_property
-indicate_indicator_get_type
indicate_indicator_hide
indicate_indicator_is_visible
indicate_indicator_list_properties
-indicate_indicator_message_get_type
-indicate_indicator_message_new
indicate_indicator_new
indicate_indicator_set_property
+indicate_indicator_set_property_icon
+indicate_indicator_set_property_time
indicate_indicator_show
indicate_indicator_user_display
-indicate_listener_display
-indicate_listener_get_property
-indicate_listener_get_property_cb
-indicate_listener_get_type
-indicate_listener_marshal_VOID__POINTER_POINTER_STRING
-indicate_listener_marshal_VOID__POINTER_POINTER_STRING_STRING
-indicate_listener_marshal_VOID__UINT_STRING
-indicate_listener_new
+</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_get_desktop
-indicate_server_get_indicator_count
-indicate_server_get_indicator_count_by_type
-indicate_server_get_indicator_list
-indicate_server_get_indicator_list_by_type
-indicate_server_get_indicator_properties
-indicate_server_get_indicator_property
-indicate_server_get_indicator_property_group
+indicate_server_emit_server_display
indicate_server_get_next_id
-indicate_server_get_type
indicate_server_hide
-indicate_server_new
indicate_server_ref_default
indicate_server_remove_indicator
-indicate_server_set_dbus_object
indicate_server_set_default
indicate_server_set_desktop_file
+indicate_server_set_type
indicate_server_show
-indicate_server_show_indicator_to_user
-org_freedesktop_indicator_get_desktop
-org_freedesktop_indicator_get_desktop_async
-org_freedesktop_indicator_get_desktop_reply
-org_freedesktop_indicator_get_indicator_count
-org_freedesktop_indicator_get_indicator_count_async
-org_freedesktop_indicator_get_indicator_count_by_type
-org_freedesktop_indicator_get_indicator_count_by_type_async
-org_freedesktop_indicator_get_indicator_count_by_type_reply
-org_freedesktop_indicator_get_indicator_count_reply
-org_freedesktop_indicator_get_indicator_list
-org_freedesktop_indicator_get_indicator_list_async
-org_freedesktop_indicator_get_indicator_list_by_type
-org_freedesktop_indicator_get_indicator_list_by_type_async
-org_freedesktop_indicator_get_indicator_list_by_type_reply
-org_freedesktop_indicator_get_indicator_list_reply
-org_freedesktop_indicator_get_indicator_properties
-org_freedesktop_indicator_get_indicator_properties_async
-org_freedesktop_indicator_get_indicator_properties_reply
-org_freedesktop_indicator_get_indicator_property
-org_freedesktop_indicator_get_indicator_property_async
-org_freedesktop_indicator_get_indicator_property_group
-org_freedesktop_indicator_get_indicator_property_group_async
-org_freedesktop_indicator_get_indicator_property_group_reply
-org_freedesktop_indicator_get_indicator_property_reply
-org_freedesktop_indicator_show_indicator_to_user
-org_freedesktop_indicator_show_indicator_to_user_async
-org_freedesktop_indicator_show_indicator_to_user_reply
+</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/tmpl/libindicate-unused.sgml b/docs/reference/tmpl/libindicate-unused.sgml
index d4e3767..c3152b1 100644
--- a/docs/reference/tmpl/libindicate-unused.sgml
+++ b/docs/reference/tmpl/libindicate-unused.sgml
@@ -1,195 +1,14 @@
-<!-- ##### FUNCTION dbus_glib_marshal_indicate_server_BOOLEAN__POINTER_POINTER ##### -->
+<!-- ##### FUNCTION indicate_server_new ##### -->
<para>
</para>
-@closure:
-@return_value:
-@n_param_values:
-@param_values:
-@invocation_hint:
-@marshal_data:
-
-<!-- ##### FUNCTION dbus_glib_marshal_indicate_server_BOOLEAN__STRING_POINTER_POINTER ##### -->
-<para>
-
-</para>
-
-@closure:
-@return_value:
-@n_param_values:
-@param_values:
-@invocation_hint:
-@marshal_data:
-
-<!-- ##### FUNCTION dbus_glib_marshal_indicate_server_BOOLEAN__UINT_BOXED_POINTER_POINTER ##### -->
-<para>
-
-</para>
-
-@closure:
-@return_value:
-@n_param_values:
-@param_values:
-@invocation_hint:
-@marshal_data:
-
-<!-- ##### FUNCTION dbus_glib_marshal_indicate_server_BOOLEAN__UINT_POINTER ##### -->
-<para>
-
-</para>
-
-@closure:
-@return_value:
-@n_param_values:
-@param_values:
-@invocation_hint:
-@marshal_data:
-
-<!-- ##### FUNCTION dbus_glib_marshal_indicate_server_BOOLEAN__UINT_POINTER_POINTER ##### -->
-<para>
-
-</para>
-
-@closure:
-@return_value:
-@n_param_values:
-@param_values:
-@invocation_hint:
-@marshal_data:
-
-<!-- ##### FUNCTION dbus_glib_marshal_indicate_server_BOOLEAN__UINT_STRING_POINTER_POINTER ##### -->
-<para>
-
-</para>
-
-@closure:
-@return_value:
-@n_param_values:
-@param_values:
-@invocation_hint:
-@marshal_data:
-
-<!-- ##### FUNCTION indicate_listener_marshal_VOID__POINTER_POINTER_STRING ##### -->
-<para>
-
-</para>
-
-@closure:
-@return_value:
-@n_param_values:
-@param_values:
-@invocation_hint:
-@marshal_data:
-
-<!-- ##### FUNCTION indicate_listener_marshal_VOID__POINTER_POINTER_STRING_STRING ##### -->
-<para>
-
-</para>
-
-@closure:
-@return_value:
-@n_param_values:
-@param_values:
-@invocation_hint:
-@marshal_data:
-
-<!-- ##### FUNCTION indicate_listener_marshal_VOID__UINT_STRING ##### -->
-<para>
-
-</para>
-
-@closure:
-@return_value:
-@n_param_values:
-@param_values:
-@invocation_hint:
-@marshal_data:
-
-<!-- ##### FUNCTION indicate_server_get_indicator_count ##### -->
-<para>
-
-</para>
-
-@server:
-@count:
-@error:
@Returns:
-<!-- ##### FUNCTION indicate_server_get_indicator_count_by_type ##### -->
+<!-- ##### FUNCTION indicate_server_set_dbus_object ##### -->
<para>
</para>
-@server:
-@type:
-@count:
-@error:
-@Returns:
-
-<!-- ##### FUNCTION indicate_server_get_indicator_list ##### -->
-<para>
-
-</para>
-
-@server:
-@indicators:
-@error:
-@Returns:
-
-<!-- ##### FUNCTION indicate_server_get_indicator_list_by_type ##### -->
-<para>
-
-</para>
-
-@server:
-@type:
-@indicators:
-@error:
-@Returns:
-
-<!-- ##### FUNCTION indicate_server_get_indicator_properties ##### -->
-<para>
-
-</para>
-
-@server:
-@id:
-@properties:
-@error:
-@Returns:
-
-<!-- ##### FUNCTION indicate_server_get_indicator_property ##### -->
-<para>
-
-</para>
-
-@server:
-@id:
-@property:
-@value:
-@error:
-@Returns:
-
-<!-- ##### FUNCTION indicate_server_get_indicator_property_group ##### -->
-<para>
-
-</para>
-
-@server:
-@id:
-@properties:
-@value:
-@error:
-@Returns:
-
-<!-- ##### FUNCTION indicate_server_show_indicator_to_user ##### -->
-<para>
-
-</para>
-
-@server:
-@id:
-@error:
-@Returns:
+@obj: