diff options
Diffstat (limited to 'doc/libempathy')
| -rw-r--r-- | doc/libempathy/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/libempathy/libempathy-docs.sgml | 22 | ||||
| -rw-r--r-- | doc/libempathy/libempathy.types | 5 | ||||
| -rw-r--r-- | doc/libempathy/tmpl/empathy-avatar.sgml | 8 | ||||
| -rw-r--r-- | doc/libempathy/tmpl/empathy-contact-list.sgml | 58 | ||||
| -rw-r--r-- | doc/libempathy/tmpl/empathy-contact.sgml | 42 | ||||
| -rw-r--r-- | doc/libempathy/tmpl/empathy-tp-group.sgml | 64 |
7 files changed, 168 insertions, 33 deletions
diff --git a/doc/libempathy/Makefile.am b/doc/libempathy/Makefile.am index d725ff649..0988c364f 100644 --- a/doc/libempathy/Makefile.am +++ b/doc/libempathy/Makefile.am @@ -1,7 +1,7 @@ ## Process this file with automake to produce Makefile.in # We require automake 1.6 at least. -AUTOMAKE_OPTIONS = 1.6 +AUTOMAKE_OPTIONS = 1.9 # This is a blank Makefile.am for using gtk-doc. # Copy this to your project's API docs directory and modify the variables to diff --git a/doc/libempathy/libempathy-docs.sgml b/doc/libempathy/libempathy-docs.sgml index 354c5921c..6c1bd79d1 100644 --- a/doc/libempathy/libempathy-docs.sgml +++ b/doc/libempathy/libempathy-docs.sgml @@ -8,24 +8,24 @@ <chapter> <title>libempathy API reference</title> + <xi:include href="xml/empathy-time.xml"/> + <xi:include href="xml/empathy-conf.xml"/> + <xi:include href="xml/empathy-avatar.xml"/> + <xi:include href="xml/empathy-message.xml"/> + <xi:include href="xml/empathy-presence.xml"/> + <xi:include href="xml/empathy-contact.xml"/> + <xi:include href="xml/empathy-contact-list.xml"/> <xi:include href="xml/empathy-tp-group.xml"/> <xi:include href="xml/empathy-tp-contact-list.xml"/> <xi:include href="xml/empathy-tp-chat.xml"/> <xi:include href="xml/empathy-tp-chatroom.xml"/> - <xi:include href="xml/empathy-avatar.xml"/> - <xi:include href="xml/empathy-conf.xml"/> - <xi:include href="xml/empathy-message.xml"/> - <xi:include href="xml/empathy-contact-list.xml"/> + <xi:include href="xml/empathy-contact-factory.xml"/> + <xi:include href="xml/empathy-chatroom.xml"/> + <xi:include href="xml/empathy-chatroom-manager.xml"/> + <xi:include href="xml/empathy-log-manager.xml"/> <xi:include href="xml/empathy-filter.xml"/> - <xi:include href="xml/empathy-presence.xml"/> <xi:include href="xml/empathy-chandler.xml"/> - <xi:include href="xml/empathy-contact-manager.xml"/> <xi:include href="xml/empathy-idle.xml"/> - <xi:include href="xml/empathy-time.xml"/> <xi:include href="xml/empathy-utils.xml"/> - <xi:include href="xml/empathy-chatroom-manager.xml"/> - <xi:include href="xml/empathy-contact.xml"/> - <xi:include href="xml/empathy-log-manager.xml"/> - <xi:include href="xml/empathy-chatroom.xml"/> </chapter> </book> diff --git a/doc/libempathy/libempathy.types b/doc/libempathy/libempathy.types index 15955d12b..3f8d7bf01 100644 --- a/doc/libempathy/libempathy.types +++ b/doc/libempathy/libempathy.types @@ -15,6 +15,8 @@ #include <libempathy/empathy-filter.h> #include <libempathy/empathy-message.h> #include <libempathy/empathy-tp-chatroom.h> +#include <libempathy/empathy-enum-types.h> +#include <libempathy/empathy-contact-factory.h> empathy_avatar_get_type empathy_chatroom_manager_get_type @@ -33,4 +35,7 @@ empathy_contact_list_get_type empathy_filter_get_type empathy_message_get_gtype empathy_tp_chatroom_get_type +empathy_reg_ex_type_get_type +empathy_message_type_get_type +empathy_contact_factory_get_type diff --git a/doc/libempathy/tmpl/empathy-avatar.sgml b/doc/libempathy/tmpl/empathy-avatar.sgml index 3f71285c8..a34392452 100644 --- a/doc/libempathy/tmpl/empathy-avatar.sgml +++ b/doc/libempathy/tmpl/empathy-avatar.sgml @@ -34,6 +34,14 @@ empathy-avatar @format: @refcount: +<!-- ##### FUNCTION empathy_avatar_get_type ##### --> +<para> + +</para> + +@Returns: + + <!-- ##### FUNCTION empathy_avatar_new ##### --> <para> diff --git a/doc/libempathy/tmpl/empathy-contact-list.sgml b/doc/libempathy/tmpl/empathy-contact-list.sgml index a84646a8e..0babd1eff 100644 --- a/doc/libempathy/tmpl/empathy-contact-list.sgml +++ b/doc/libempathy/tmpl/empathy-contact-list.sgml @@ -102,3 +102,61 @@ empathy-contact-list @Returns: +<!-- ##### FUNCTION empathy_contact_list_get_pendings ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_get_all_groups ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_get_groups ##### --> +<para> + +</para> + +@list: +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_add_to_group ##### --> +<para> + +</para> + +@list: +@contact: +@group: + + +<!-- ##### FUNCTION empathy_contact_list_remove_from_group ##### --> +<para> + +</para> + +@list: +@contact: +@group: + + +<!-- ##### FUNCTION empathy_contact_list_rename_group ##### --> +<para> + +</para> + +@list: +@old_group: +@new_group: + + diff --git a/doc/libempathy/tmpl/empathy-contact.sgml b/doc/libempathy/tmpl/empathy-contact.sgml index 861151fb6..571414de8 100644 --- a/doc/libempathy/tmpl/empathy-contact.sgml +++ b/doc/libempathy/tmpl/empathy-contact.sgml @@ -87,16 +87,16 @@ EmpathyContact @Returns: -<!-- ##### FUNCTION empathy_contact_get_name ##### --> +<!-- ##### FUNCTION empathy_contact_set_id ##### --> <para> </para> @contact: -@Returns: +@id: -<!-- ##### FUNCTION empathy_contact_get_avatar ##### --> +<!-- ##### FUNCTION empathy_contact_get_name ##### --> <para> </para> @@ -105,16 +105,16 @@ EmpathyContact @Returns: -<!-- ##### FUNCTION empathy_contact_get_account ##### --> +<!-- ##### FUNCTION empathy_contact_set_name ##### --> <para> </para> @contact: -@Returns: +@name: -<!-- ##### FUNCTION empathy_contact_get_presence ##### --> +<!-- ##### FUNCTION empathy_contact_get_avatar ##### --> <para> </para> @@ -123,16 +123,16 @@ EmpathyContact @Returns: -<!-- ##### FUNCTION empathy_contact_get_handle ##### --> +<!-- ##### FUNCTION empathy_contact_set_avatar ##### --> <para> </para> @contact: -@Returns: +@avatar: -<!-- ##### FUNCTION empathy_contact_is_user ##### --> +<!-- ##### FUNCTION empathy_contact_get_account ##### --> <para> </para> @@ -141,58 +141,58 @@ EmpathyContact @Returns: -<!-- ##### FUNCTION empathy_contact_set_id ##### --> +<!-- ##### FUNCTION empathy_contact_set_account ##### --> <para> </para> @contact: -@id: +@account: -<!-- ##### FUNCTION empathy_contact_set_name ##### --> +<!-- ##### FUNCTION empathy_contact_get_presence ##### --> <para> </para> @contact: -@name: +@Returns: -<!-- ##### FUNCTION empathy_contact_set_avatar ##### --> +<!-- ##### FUNCTION empathy_contact_set_presence ##### --> <para> </para> @contact: -@avatar: +@presence: -<!-- ##### FUNCTION empathy_contact_set_account ##### --> +<!-- ##### FUNCTION empathy_contact_get_handle ##### --> <para> </para> @contact: -@account: +@Returns: -<!-- ##### FUNCTION empathy_contact_set_presence ##### --> +<!-- ##### FUNCTION empathy_contact_set_handle ##### --> <para> </para> @contact: -@presence: +@handle: -<!-- ##### FUNCTION empathy_contact_set_handle ##### --> +<!-- ##### FUNCTION empathy_contact_is_user ##### --> <para> </para> @contact: -@handle: +@Returns: <!-- ##### FUNCTION empathy_contact_set_is_user ##### --> diff --git a/doc/libempathy/tmpl/empathy-tp-group.sgml b/doc/libempathy/tmpl/empathy-tp-group.sgml index 6ea6206e4..8529e5f46 100644 --- a/doc/libempathy/tmpl/empathy-tp-group.sgml +++ b/doc/libempathy/tmpl/empathy-tp-group.sgml @@ -80,6 +80,16 @@ EmpathyTpGroup @arg3: @arg4: +<!-- ##### STRUCT EmpathyPendingInfo ##### --> +<para> + +</para> + +@member: +@actor: +@message: +@reason: + <!-- ##### FUNCTION empathy_tp_group_new ##### --> <para> @@ -90,6 +100,14 @@ EmpathyTpGroup @Returns: +<!-- ##### FUNCTION empathy_tp_group_close ##### --> +<para> + +</para> + +@group: + + <!-- ##### FUNCTION empathy_tp_group_add_members ##### --> <para> @@ -139,6 +157,24 @@ EmpathyTpGroup @Returns: +<!-- ##### FUNCTION empathy_tp_group_get_local_pendings ##### --> +<para> + +</para> + +@group: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_group_get_remote_pendings ##### --> +<para> + +</para> + +@group: +@Returns: + + <!-- ##### FUNCTION empathy_tp_group_get_name ##### --> <para> @@ -148,6 +184,15 @@ EmpathyTpGroup @Returns: +<!-- ##### FUNCTION empathy_tp_group_get_self_contact ##### --> +<para> + +</para> + +@group: +@Returns: + + <!-- ##### FUNCTION empathy_tp_group_get_object_path ##### --> <para> @@ -167,3 +212,22 @@ EmpathyTpGroup @Returns: +<!-- ##### FUNCTION empathy_pending_info_new ##### --> +<para> + +</para> + +@member: +@actor: +@message: +@Returns: + + +<!-- ##### FUNCTION empathy_pending_info_free ##### --> +<para> + +</para> + +@info: + + |