aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorXavier Claessens <xclaesse@src.gnome.org>2008-08-28 17:52:21 +0800
committerXavier Claessens <xclaesse@src.gnome.org>2008-08-28 17:52:21 +0800
commitd93fa6862e0f8ab4028c1d46acaca38b049d97e1 (patch)
tree2bcf9cc27983c3815f2f0e034fb7c5a48f17e94e /docs
parent193bab8c8e34147380151f5ae6553a11f0c87ecc (diff)
downloadgsoc2013-empathy-d93fa6862e0f8ab4028c1d46acaca38b049d97e1.tar
gsoc2013-empathy-d93fa6862e0f8ab4028c1d46acaca38b049d97e1.tar.gz
gsoc2013-empathy-d93fa6862e0f8ab4028c1d46acaca38b049d97e1.tar.bz2
gsoc2013-empathy-d93fa6862e0f8ab4028c1d46acaca38b049d97e1.tar.lz
gsoc2013-empathy-d93fa6862e0f8ab4028c1d46acaca38b049d97e1.tar.xz
gsoc2013-empathy-d93fa6862e0f8ab4028c1d46acaca38b049d97e1.tar.zst
gsoc2013-empathy-d93fa6862e0f8ab4028c1d46acaca38b049d97e1.zip
Update API doc and add a README to explain how to keep it updated.
svn path=/trunk/; revision=1397
Diffstat (limited to 'docs')
-rw-r--r--docs/README8
-rw-r--r--docs/libempathy-gtk/libempathy-gtk-docs.sgml8
-rw-r--r--docs/libempathy-gtk/libempathy-gtk.types5
-rw-r--r--docs/libempathy/libempathy-docs.sgml51
4 files changed, 43 insertions, 29 deletions
diff --git a/docs/README b/docs/README
new file mode 100644
index 000000000..a7cdfe278
--- /dev/null
+++ b/docs/README
@@ -0,0 +1,8 @@
+To be sure the doc is up to date:
+
+1) Update libempathy.types
+empathy/libempathy$ grep _get_type *.h | grep GType | awk '{ print $2 }'
+
+2) Update libempathy-docs.sgml
+empathy$ make
+empathy/doc/libempathy$ for f in `ls -l xml/*.xml | awk '{ print $8 }'`; do echo " <xi:include href=\"$f\"/>"; done
diff --git a/docs/libempathy-gtk/libempathy-gtk-docs.sgml b/docs/libempathy-gtk/libempathy-gtk-docs.sgml
index c194bd06b..ca6a18077 100644
--- a/docs/libempathy-gtk/libempathy-gtk-docs.sgml
+++ b/docs/libempathy-gtk/libempathy-gtk-docs.sgml
@@ -17,15 +17,16 @@
<chapter id="libempathy_api">
<title>libempathy-gtk API reference</title>
<xi:include href="xml/empathy-account-chooser.xml"/>
- <xi:include href="xml/empathy-account-widget.xml"/>
<xi:include href="xml/empathy-account-widget-irc.xml"/>
+ <xi:include href="xml/empathy-account-widget-sip.xml"/>
+ <xi:include href="xml/empathy-account-widget.xml"/>
<xi:include href="xml/empathy-avatar-chooser.xml"/>
<xi:include href="xml/empathy-avatar-image.xml"/>
<xi:include href="xml/empathy-cell-renderer-activatable.xml"/>
<xi:include href="xml/empathy-cell-renderer-expander.xml"/>
<xi:include href="xml/empathy-cell-renderer-text.xml"/>
- <xi:include href="xml/empathy-chat.xml"/>
<xi:include href="xml/empathy-chat-view.xml"/>
+ <xi:include href="xml/empathy-chat.xml"/>
<xi:include href="xml/empathy-conf.xml"/>
<xi:include href="xml/empathy-contact-dialogs.xml"/>
<xi:include href="xml/empathy-contact-list-store.xml"/>
@@ -42,7 +43,10 @@
<xi:include href="xml/empathy-smiley-manager.xml"/>
<xi:include href="xml/empathy-spell-dialog.xml"/>
<xi:include href="xml/empathy-spell.xml"/>
+ <xi:include href="xml/empathy-theme-boxes.xml"/>
+ <xi:include href="xml/empathy-theme-irc.xml"/>
<xi:include href="xml/empathy-theme-manager.xml"/>
+ <xi:include href="xml/empathy-theme.xml"/>
<xi:include href="xml/empathy-ui-utils.xml"/>
</chapter>
</part>
diff --git a/docs/libempathy-gtk/libempathy-gtk.types b/docs/libempathy-gtk/libempathy-gtk.types
index 37e035551..59b9ce76d 100644
--- a/docs/libempathy-gtk/libempathy-gtk.types
+++ b/docs/libempathy-gtk/libempathy-gtk.types
@@ -6,11 +6,14 @@ empathy_cell_renderer_expander_get_type
empathy_cell_renderer_text_get_type
empathy_chat_get_type
empathy_chat_view_get_type
+empathy_conf_get_type
empathy_contact_list_store_get_type
empathy_contact_list_view_get_type
-empathy_contact_widget_flags_get_type
empathy_contact_list_store_sort_get_type
empathy_contact_list_store_col_get_type
+empathy_contact_list_feature_flags_get_type
+empathy_contact_widget_flags_get_type
+empathy_contact_feature_flags_get_type
empathy_presence_chooser_get_type
empathy_smiley_manager_get_type
empathy_theme_boxes_get_type
diff --git a/docs/libempathy/libempathy-docs.sgml b/docs/libempathy/libempathy-docs.sgml
index e3ca78b53..a1a73ee80 100644
--- a/docs/libempathy/libempathy-docs.sgml
+++ b/docs/libempathy/libempathy-docs.sgml
@@ -16,32 +16,31 @@
<title>API Reference</title>
<chapter id="libempathy_api">
<title>libempathy API reference</title>
- <xi:include href="xml/empathy-chatroom-manager.xml"/>
- <xi:include href="xml/empathy-chatroom.xml"/>
- <xi:include href="xml/empathy-contact-factory.xml"/>
- <xi:include href="xml/empathy-contact-groups.xml"/>
- <xi:include href="xml/empathy-contact-list.xml"/>
- <xi:include href="xml/empathy-contact-manager.xml"/>
- <xi:include href="xml/empathy-contact.xml"/>
- <xi:include href="xml/empathy-dispatcher.xml"/>
- <xi:include href="xml/empathy-enum-types.xml"/>
- <xi:include href="xml/empathy-idle.xml"/>
- <xi:include href="xml/empathy-irc-server.xml"/>
- <xi:include href="xml/empathy-irc-network.xml"/>
- <xi:include href="xml/empathy-irc-network-manager.xml"/>
- <xi:include href="xml/empathy-log-manager.xml"/>
- <xi:include href="xml/empathy-message.xml"/>
- <xi:include href="xml/empathy-status-presets.xml"/>
- <xi:include href="xml/empathy-time.xml"/>
- <xi:include href="xml/empathy-tp-call.xml"/>
- <xi:include href="xml/empathy-tp-chat.xml"/>
- <xi:include href="xml/empathy-tp-contact-factory.xml"/>
- <xi:include href="xml/empathy-tp-contact-list.xml"/>
- <xi:include href="xml/empathy-tp-group.xml"/>
- <xi:include href="xml/empathy-tp-roomlist.xml"/>
- <xi:include href="xml/empathy-tp-tube.xml"/>
- <xi:include href="xml/empathy-tube-handler.xml"/>
- <xi:include href="xml/empathy-utils.xml"/>
+ <xi:include href="xml/empathy-chatroom-manager.xml"/>
+ <xi:include href="xml/empathy-chatroom.xml"/>
+ <xi:include href="xml/empathy-contact-factory.xml"/>
+ <xi:include href="xml/empathy-contact-groups.xml"/>
+ <xi:include href="xml/empathy-contact-list.xml"/>
+ <xi:include href="xml/empathy-contact-manager.xml"/>
+ <xi:include href="xml/empathy-contact.xml"/>
+ <xi:include href="xml/empathy-dispatcher.xml"/>
+ <xi:include href="xml/empathy-idle.xml"/>
+ <xi:include href="xml/empathy-irc-network-manager.xml"/>
+ <xi:include href="xml/empathy-irc-network.xml"/>
+ <xi:include href="xml/empathy-irc-server.xml"/>
+ <xi:include href="xml/empathy-log-manager.xml"/>
+ <xi:include href="xml/empathy-message.xml"/>
+ <xi:include href="xml/empathy-status-presets.xml"/>
+ <xi:include href="xml/empathy-time.xml"/>
+ <xi:include href="xml/empathy-tp-call.xml"/>
+ <xi:include href="xml/empathy-tp-chat.xml"/>
+ <xi:include href="xml/empathy-tp-contact-factory.xml"/>
+ <xi:include href="xml/empathy-tp-contact-list.xml"/>
+ <xi:include href="xml/empathy-tp-group.xml"/>
+ <xi:include href="xml/empathy-tp-roomlist.xml"/>
+ <xi:include href="xml/empathy-tp-tube.xml"/>
+ <xi:include href="xml/empathy-tube-handler.xml"/>
+ <xi:include href="xml/empathy-utils.xml"/>
</chapter>
</part>