[libyelp] Adding gtk-doc API reference

4 files changed, 122 insertions, 0 deletions

diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 00000000..99b6b71a
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = libyelp
diff --git a/docs/libyelp/Makefile.am b/docs/libyelp/Makefile.am
new file mode 100644
index 00000000..dd54bd0b
--- /dev/null
+++ b/docs/libyelp/Makefile.am
@@ -0,0 +1,79 @@
+AUTOMAKE_OPTIONS = 1.6
+
+DOC_MODULE = libyelp
+
+DOC_MAIN_SGML_FILE = libyelp-docs.xml
+
+SCAN_OPTIONS = --deprecated-guards="G_DISABLE_DEPRECATED" --rebuild-types
+
+SCANGOBJ_OPTIONS = --type-init-func="g_type_init();g_thread_init(NULL);"
+
+DOC_SOURCE_DIR = $(top_srcdir)/libyelp
+
+GTKDOC_CFLAGS =						\
+	$(YELP_CFLAGS)					\
+	-I$(top_srcdir)/libyelp
+
+GTKDOC_LIBS =						\
+	$(YELP_LIBS)					\
+	$(top_builddir)/libyelp/libyelp.la
+
+HFILE_GLOB = $(top_srcdir)/libyelp/*.h
+CFILE_GLOB = $(top_srcdir)/libyelp/*.c
+IGNORE_HFILES = yelp-debug.h
+
+MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=yelp --ignore-files='yelp-debug.h yelp-debug.c'
+
+content_files = version.xml
+
+extra_viles = version.xml.in
+
+include $(top_srcdir)/gtk-doc.make
+
+EXTRA_DIST += version.xm.in
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+#MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkhtml
+#MKHTML_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+#FIXXREF_OPTIONS=
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+#EXTRA_HFILES=
+
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+#HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+#content_files=
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+#expand_content_files=
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+#EXTRA_DIST +=
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Comment this out if you want your docs-status tested during 'make check'
+#if ENABLE_GTK_DOC
+#TESTS_ENVIRONMENT = cd $(srcsrc) &&
+#TESTS = $(GTKDOC_CHECK)
+#endif
diff --git a/docs/libyelp/libyelp-docs.xml b/docs/libyelp/libyelp-docs.xml
new file mode 100644
index 00000000..77fcf523
--- /dev/null
+++ b/docs/libyelp/libyelp-docs.xml
@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index">
+  <bookinfo>
+    <title>Yelp Reference Manual</title>
+    <releaseinfo>for libyelp &version;</releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>API Reference</title>
+    <section>
+      <title>Widgets</title>
+      <include href="xml/yelp-view.xml" xmlns="http://www.w3.org/2003/XInclude"/>
+      <include href="xml/yelp-location-entry.xml" xmlns="http://www.w3.org/2003/XInclude"/>
+    </section>
+    <section>
+      <title>Document Processing</title>
+      <include href="xml/yelp-document.xml" xmlns="http://www.w3.org/2003/XInclude"/>
+      <include href="xml/yelp-simple-document.xml" xmlns="http://www.w3.org/2003/XInclude"/>
+    </section>
+
+    <include href="xml/yelp-uri.xml" xmlns="http://www.w3.org/2003/XInclude"/>
+    <include href="xml/yelp-settings.xml" xmlns="http://www.w3.org/2003/XInclude"/>
+    <include href="xml/yelp-error.xml" xmlns="http://www.w3.org/2003/XInclude"/>
+
+  </chapter>
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+     <include href="xml/tree_index.sgml" xmlns="http://www.w3.org/2003/XInclude"/>
+  </chapter>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <include href="xml/api-index-full.xml" xmlns="http://www.w3.org/2003/XInclude"><fallback/></include>
+  </index>
+
+  <include href="xml/annotation-glossary.xml" xmlns="http://www.w3.org/2003/XInclude"><fallback/></include>
+</book>
diff --git a/docs/libyelp/version.xml.in b/docs/libyelp/version.xml.in
new file mode 100644
index 00000000..d78bda93
--- /dev/null
+++ b/docs/libyelp/version.xml.in
@@ -0,0 +1 @@
+@VERSION@