diff options
Diffstat (limited to 'docs/libempathy')
-rw-r--r-- | docs/libempathy/Makefile.am | 58 | ||||
-rw-r--r-- | docs/libempathy/libempathy-docs.sgml | 50 | ||||
-rw-r--r-- | docs/libempathy/libempathy.types | 22 | ||||
-rw-r--r-- | docs/libempathy/version.xml.in | 1 |
4 files changed, 131 insertions, 0 deletions
diff --git a/docs/libempathy/Makefile.am b/docs/libempathy/Makefile.am new file mode 100644 index 000000000..5192a0556 --- /dev/null +++ b/docs/libempathy/Makefile.am @@ -0,0 +1,58 @@ +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 \ + $(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/docs/libempathy/libempathy-docs.sgml b/docs/libempathy/libempathy-docs.sgml new file mode 100644 index 000000000..e74d48df7 --- /dev/null +++ b/docs/libempathy/libempathy-docs.sgml @@ -0,0 +1,50 @@ +<?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-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-tp-call.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-chandler.xml"/> + <xi:include href="xml/empathy-idle.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/docs/libempathy/libempathy.types b/docs/libempathy/libempathy.types new file mode 100644 index 000000000..6c46c40a4 --- /dev/null +++ b/docs/libempathy/libempathy.types @@ -0,0 +1,22 @@ +empathy_avatar_get_type +empathy_chatroom_manager_get_type +empathy_contact_manager_get_type +empathy_idle_get_type +empathy_presence_get_type +empathy_tp_contact_list_get_type +empathy_conf_get_type +empathy_log_manager_get_type +empathy_tp_group_get_type +empathy_chandler_get_type +empathy_contact_get_type +empathy_tp_chat_get_type +empathy_chatroom_get_type +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 +empathy_tp_call_get_type + diff --git a/docs/libempathy/version.xml.in b/docs/libempathy/version.xml.in new file mode 100644 index 000000000..d78bda934 --- /dev/null +++ b/docs/libempathy/version.xml.in @@ -0,0 +1 @@ +@VERSION@ |