diff options
Diffstat (limited to 'trunk/docs')
-rw-r--r-- | trunk/docs/.gitignore | 8 | ||||
-rw-r--r-- | trunk/docs/Makefile.am | 2 | ||||
-rw-r--r-- | trunk/docs/libempathy-gtk/.gitignore | 6 | ||||
-rw-r--r-- | trunk/docs/libempathy-gtk/Makefile.am | 59 | ||||
-rw-r--r-- | trunk/docs/libempathy-gtk/libempathy-gtk-docs.sgml | 59 | ||||
-rw-r--r-- | trunk/docs/libempathy-gtk/libempathy-gtk.types | 20 | ||||
-rw-r--r-- | trunk/docs/libempathy-gtk/version.xml.in | 1 | ||||
-rw-r--r-- | trunk/docs/libempathy/.gitignore | 6 | ||||
-rw-r--r-- | trunk/docs/libempathy/Makefile.am | 60 | ||||
-rw-r--r-- | trunk/docs/libempathy/libempathy-docs.sgml | 57 | ||||
-rw-r--r-- | trunk/docs/libempathy/libempathy.types | 21 | ||||
-rw-r--r-- | trunk/docs/libempathy/version.xml.in | 1 |
12 files changed, 300 insertions, 0 deletions
diff --git a/trunk/docs/.gitignore b/trunk/docs/.gitignore new file mode 100644 index 000000000..a7316fb11 --- /dev/null +++ b/trunk/docs/.gitignore @@ -0,0 +1,8 @@ +html +xml +tmpl +*.txt +*.stamp + +version.xml + diff --git a/trunk/docs/Makefile.am b/trunk/docs/Makefile.am new file mode 100644 index 000000000..2053a4567 --- /dev/null +++ b/trunk/docs/Makefile.am @@ -0,0 +1,2 @@ +SUBDIRS = libempathy libempathy-gtk + diff --git a/trunk/docs/libempathy-gtk/.gitignore b/trunk/docs/libempathy-gtk/.gitignore new file mode 100644 index 000000000..51f581636 --- /dev/null +++ b/trunk/docs/libempathy-gtk/.gitignore @@ -0,0 +1,6 @@ +libempathy-gtk.args +libempathy-gtk.hierarchy +libempathy-gtk.interfaces +libempathy-gtk.prerequisites +libempathy-gtk.signals + diff --git a/trunk/docs/libempathy-gtk/Makefile.am b/trunk/docs/libempathy-gtk/Makefile.am new file mode 100644 index 000000000..1a666bafb --- /dev/null +++ b/trunk/docs/libempathy-gtk/Makefile.am @@ -0,0 +1,59 @@ +NULL = + +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module. +DOC_MODULE=libempathy-gtk + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=libempathy-gtk-docs.sgml + +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED" + +# The directory containing the source code. Relative to $(srcdir) +DOC_SOURCE_DIR=$(top_srcdir)/libempathy-gtk + +HFILE_GLOB=$(top_srcdir)/libempathy-gtk/*.h +CFILE_GLOB=$(top_srcdir)/libempathy-gtk/*.c + +# Headers to ignore +IGNORE_HFILES= \ + empathy-gtk-enum-types.h \ + stamp-empathy-gtk-enum-types.h \ + ephy-spinner.h \ + totem-subtitle-encoding.h \ + $(NULL) + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +GTKDOC_CFLAGS = \ + -I$(srcdir) \ + -I$(top_srcdir) \ + -I$(top_srcdir)/libempathy-gtk \ + -I$(top_builddir) \ + -I$(top_builddir)/libempathy-gtk \ + $(EMPATHY_CFLAGS) \ + $(NULL) + +GTKDOC_LIBS = \ + $(top_builddir)/libempathy-gtk/libempathy-gtk.la \ + $(top_builddir)/libempathy/libempathy.la \ + $(EMPATHY_LIBS) \ + $(NULL) + +# Extra options to supply to gtkdoc-mkdb +MKDB_OPTIONS = --output-format=xml --sgml-mode + +# Images to copy into HTML directory +HTML_IMAGES = + +content_files = \ + version.xml + +extra_files = version.xml.in + +include $(top_srcdir)/gtk-doc.make + +EXTRA_DIST += \ + version.xml.in diff --git a/trunk/docs/libempathy-gtk/libempathy-gtk-docs.sgml b/trunk/docs/libempathy-gtk/libempathy-gtk-docs.sgml new file mode 100644 index 000000000..6256b3e92 --- /dev/null +++ b/trunk/docs/libempathy-gtk/libempathy-gtk-docs.sgml @@ -0,0 +1,59 @@ +<?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" [ +<!ENTITY version SYSTEM "version.xml"> +]> +<book lang="en" id="libempathy-gtk" xmlns:xi="http://www.w3.org/2003/XInclude"> +<title>libempathy-gtk Reference Manual</title> + <bookinfo> + <title>libempathy-gtk Reference Manual</title> + <releaseinfo>for libempathy-gtk &version;</releaseinfo> + </bookinfo> + <part> + <title>libempathy-gtk Overview</title> + </part> + <part> + <title>API Reference</title> + <chapter id="libempathy_api"> + <title>libempathy-gtk API reference</title> + <xi:include href="xml/empathy-account-chooser.xml"/> + <xi:include href="xml/empathy-accounts-dialog.xml"/> + <xi:include href="xml/empathy-account-widget.xml"/> + <xi:include href="xml/empathy-account-widget-irc.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-conf.xml"/> + <xi:include href="xml/empathy-contact-dialogs.xml"/> + <xi:include href="xml/empathy-contact-list-store.xml"/> + <xi:include href="xml/empathy-contact-list-view.xml"/> + <xi:include href="xml/empathy-contact-menu.xml"/> + <xi:include href="xml/empathy-contact-widget.xml"/> + <xi:include href="xml/empathy-geometry.xml"/> + <xi:include href="xml/empathy-images.xml"/> + <xi:include href="xml/empathy-irc-network-dialog.xml"/> + <xi:include href="xml/empathy-log-window.xml"/> + <xi:include href="xml/empathy-new-message-dialog.xml"/> + <xi:include href="xml/empathy-presence-chooser.xml"/> + <xi:include href="xml/empathy-profile-chooser.xml"/> + <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-manager.xml"/> + <xi:include href="xml/empathy-ui-utils.xml"/> + </chapter> + </part> + + <chapter id="libempathy-gtk-hierarchy"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + + <index> + <title id="index-all">Index</title> + </index> +</book> diff --git a/trunk/docs/libempathy-gtk/libempathy-gtk.types b/trunk/docs/libempathy-gtk/libempathy-gtk.types new file mode 100644 index 000000000..37e035551 --- /dev/null +++ b/trunk/docs/libempathy-gtk/libempathy-gtk.types @@ -0,0 +1,20 @@ +empathy_account_chooser_get_type +empathy_avatar_chooser_get_type +empathy_avatar_image_get_type +empathy_cell_renderer_activatable_get_type +empathy_cell_renderer_expander_get_type +empathy_cell_renderer_text_get_type +empathy_chat_get_type +empathy_chat_view_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_presence_chooser_get_type +empathy_smiley_manager_get_type +empathy_theme_boxes_get_type +empathy_theme_get_type +empathy_theme_irc_get_type +empathy_theme_manager_get_type + diff --git a/trunk/docs/libempathy-gtk/version.xml.in b/trunk/docs/libempathy-gtk/version.xml.in new file mode 100644 index 000000000..d78bda934 --- /dev/null +++ b/trunk/docs/libempathy-gtk/version.xml.in @@ -0,0 +1 @@ +@VERSION@ diff --git a/trunk/docs/libempathy/.gitignore b/trunk/docs/libempathy/.gitignore new file mode 100644 index 000000000..0a5b4cabb --- /dev/null +++ b/trunk/docs/libempathy/.gitignore @@ -0,0 +1,6 @@ +libempathy.args +libempathy.hierarchy +libempathy.interfaces +libempathy.prerequisites +libempathy.signals + diff --git a/trunk/docs/libempathy/Makefile.am b/trunk/docs/libempathy/Makefile.am new file mode 100644 index 000000000..7cf0108c2 --- /dev/null +++ b/trunk/docs/libempathy/Makefile.am @@ -0,0 +1,60 @@ +NULL = + +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module. +DOC_MODULE=libempathy + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=libempathy-docs.sgml + +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED" + +# The directory containing the source code. Relative to $(srcdir) +DOC_SOURCE_DIR=$(top_srcdir)/libempathy + +HFILE_GLOB=$(top_srcdir)/libempathy/*.h +CFILE_GLOB=$(top_srcdir)/libempathy/*.c + +# Headers to ignore +IGNORE_HFILES= \ + empathy-filter-glue.h \ + empathy-debug.h \ + empathy-marshal.h \ + tp-stream-engine-gen.h \ + stamp-empathy-enum-types.h \ + empathy-chandler-glue.h \ + $(NULL) + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +GTKDOC_CFLAGS = \ + -I$(srcdir) \ + -I$(top_srcdir) \ + -I$(top_srcdir)/libempathy \ + -I$(top_builddir) \ + -I$(top_builddir)/libempathy \ + $(LIBEMPATHY_CFLAGS) \ + $(NULL) + +GTKDOC_LIBS = \ + $(top_builddir)/libempathy/libempathy.la \ + $(LIBEMPATHY_LIBS) \ + $(NULL) + +# Extra options to supply to gtkdoc-mkdb +MKDB_OPTIONS = --output-format=xml --sgml-mode + +# Images to copy into HTML directory +HTML_IMAGES = + +content_files = \ + version.xml + +extra_files = version.xml.in + +include $(top_srcdir)/gtk-doc.make + +EXTRA_DIST += \ + version.xml.in diff --git a/trunk/docs/libempathy/libempathy-docs.sgml b/trunk/docs/libempathy/libempathy-docs.sgml new file mode 100644 index 000000000..6e040b0cb --- /dev/null +++ b/trunk/docs/libempathy/libempathy-docs.sgml @@ -0,0 +1,57 @@ +<?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" [ +<!ENTITY version SYSTEM "version.xml"> +]> +<book lang="en" id="libempathy" xmlns:xi="http://www.w3.org/2003/XInclude"> +<title>libempathy Reference Manual</title> + <bookinfo> + <title>libempathy Reference Manual</title> + <releaseinfo>for libempathy &version;</releaseinfo> + </bookinfo> + <part> + <title>libempathy Overview</title> + </part> + <part> + <title>API Reference</title> + <chapter id="libempathy_api"> + <title>libempathy API reference</title> + <xi:include href="xml/empathy-avatar.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-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"/> + </chapter> + </part> + + <chapter id="libempathy-hierarchy"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + + <index> + <title id="index-all">Index</title> + </index> +</book> diff --git a/trunk/docs/libempathy/libempathy.types b/trunk/docs/libempathy/libempathy.types new file mode 100644 index 000000000..dead1e5c4 --- /dev/null +++ b/trunk/docs/libempathy/libempathy.types @@ -0,0 +1,21 @@ +empathy_contact_list_get_type +empathy_contact_manager_get_type +empathy_reg_ex_type_get_type +empathy_capabilities_get_type +empathy_idle_get_type +empathy_log_manager_get_type +empathy_message_get_type +empathy_tp_call_status_get_type +empathy_tp_call_get_type +empathy_tp_chat_get_type +empathy_tp_contact_factory_get_type +empathy_tp_contact_list_get_type +empathy_tp_group_get_type +empathy_tp_roomlist_get_type +empathy_tp_tube_get_type +empathy_tube_handler_get_type +empathy_irc_server_get_type +empathy_irc_network_get_type +empathy_irc_network_manager_get_type +empathy_dispatcher_get_type + diff --git a/trunk/docs/libempathy/version.xml.in b/trunk/docs/libempathy/version.xml.in new file mode 100644 index 000000000..d78bda934 --- /dev/null +++ b/trunk/docs/libempathy/version.xml.in @@ -0,0 +1 @@ +@VERSION@ |