GNOME.org
 

[emerillon] Add stub API documentation

commit dc9065e67f476c4d411a128b5b316519aa9b4d5b
Author: Å?ukasz JernaÅ? <deejay1 srem org>
Date:   Wed May 5 15:52:18 2010 +0200

    Add stub API documentation

 .gitignore                         |    9 +++
 Makefile.am                        |    2 +-
 autogen.sh                         |   10 ++--
 configure.ac                       |   12 ++++
 docs/Makefile.am                   |    2 +
 docs/reference/Makefile.am         |  102 ++++++++++++++++++++++++++++++++++++
 docs/reference/emerillon-docs.sgml |   35 ++++++++++++
 docs/reference/version.xml.in      |    1 +
 emerillon/Makefile.am              |   16 ++++--
 9 files changed, 177 insertions(+), 12 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index 086e1fc..31678b7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,6 +12,8 @@
 *.lo
 *.pc
 
+m4/*
+
 Makefile
 Makefile.in
 .dirstamp
@@ -26,6 +28,7 @@ config.status
 config.sub
 configure
 depcomp
+gtk-doc.make
 install-sh
 intltool-extract.in
 intltool-merge.in
@@ -38,6 +41,12 @@ omf.make
 stamp-h1
 xmldocs.make
 
+ChangeLog
+
+docs/reference/html
+docs/reference/xml
+*.stamp
+
 po/.intltool-merge-cache
 po/POTFILES
 po/stamp-it
diff --git a/Makefile.am b/Makefile.am
index c9a540d..c9bd11c 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = cut-paste emerillon data plugins po bindings
+SUBDIRS = cut-paste emerillon data plugins po bindings docs
 
 EXTRA_DIST = 			\
 	autogen.sh		\
diff --git a/autogen.sh b/autogen.sh
index 4a6cde3..3cbb9b2 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -17,14 +17,14 @@ which gnome-autogen.sh || {
     exit 1
 }
 
-#gtkdocize || {
-#    echo "You are missing gtk-doc. Please install it"
-#    exit 1
-#}
+which gtkdocize || {
+    echo "You are missing gtk-doc. Please install it"
+    exit 1
+}
 
 REQUIRED_AUTOCONF_VERSION=2.59
 REQUIRED_AUTOMAKE_VERSION=1.7
 REQUIRED_INTLTOOL_VERSION=0.40.0
 REQUIRED_PKG_CONFIG_VERSION=0.16.0
-REQUIRED_GTK_DOC_VERSION=1.9
+REQUIRED_GTK_DOC_VERSION=1.14
 USE_GNOME2_MACROS=1 USE_COMMON_DOC_BUILD=yes . gnome-autogen.sh
diff --git a/configure.ac b/configure.ac
index ada4cc2..efa0f1a 100644
--- a/configure.ac
+++ b/configure.ac
@@ -23,6 +23,7 @@ AC_SUBST(EMERILLON_API_VERSION)
 AM_INIT_AUTOMAKE([1.8 dist-bzip2 no-dist-gzip -Wno-portability])
 
 AC_CONFIG_HEADERS(config.h)
+AC_CONFIG_MACRO_DIR(m4)
 
 AM_MAINTAINER_MODE
 
@@ -39,6 +40,7 @@ AC_PROG_INSTALL
 AC_PROG_MAKE_SET
 
 m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES([yes])])
+GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
 
 ###############
 # GLib tools. #
@@ -67,6 +69,13 @@ GETTEXT_PACKAGE=AC_PACKAGE_NAME
 AC_SUBST(GETTEXT_PACKAGE)
 AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE,"$GETTEXT_PACKAGE", [Gettext package])
 
+###################
+# gnome-doc-utils #
+###################
+
+PKG_PROG_PKG_CONFIG
+GNOME_DOC_INIT
+
 ################
 # Dependencies #
 ################
@@ -163,6 +172,9 @@ cut-paste/Makefile
 data/Makefile
 data/emerillon.pc
 data/emerillon.desktop.in
+docs/Makefile
+docs/reference/Makefile
+docs/reference/version.xml
 plugins/Makefile
 bindings/Makefile
 bindings/vala/Makefile
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..dc5adb0
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,2 @@
+SUBDIRS = reference
+
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 0000000..93b1c05
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1,102 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=emerillon
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../../emerillon
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+#SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+#SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# 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=--path="$(abs_builddir)"
+
+# 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=
+
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=$(top_srcdir)/emerillon/*.h
+CFILE_GLOB=$(top_srcdir)/emerillon/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files to ignore when scanning. Use base file name, no paths
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_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=version.xml
+
+# 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=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(EMERILLON_CFLAGS)
+GTKDOC_LIBS=$(top_builddir)/emerillon/libemerillon.la $(EMERILLON_LIBS)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST +=version.xml.in
+
+# 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/reference/emerillon-docs.sgml b/docs/reference/emerillon-docs.sgml
new file mode 100644
index 0000000..e8b87b5
--- /dev/null
+++ b/docs/reference/emerillon-docs.sgml
@@ -0,0 +1,35 @@
+<?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 % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+  <!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index">
+  <bookinfo>
+    <title>Emerillon Reference Manual</title>
+    <releaseinfo>
+      for Emerillon &version;
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>emerillon</title>
+        <xi:include href="xml/sidebar.xml"/>
+    <xi:include href="xml/manager.xml"/>
+    <xi:include href="xml/window.xml"/>
+    <xi:include href="xml/preferences.xml"/>
+    <xi:include href="xml/config-keys.xml"/>
+
+  </chapter>
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+     <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/docs/reference/version.xml.in
@@ -0,0 +1 @@
+ VERSION@
diff --git a/emerillon/Makefile.am b/emerillon/Makefile.am
index 2854a60..a85f81c 100644
--- a/emerillon/Makefile.am
+++ b/emerillon/Makefile.am
@@ -14,16 +14,13 @@ INCLUDES =								\
 
 bin_PROGRAMS = emerillon
 
-emerillon_LDADD = \
-	$(EMERILLON_LIBS)
+noinst_LTLIBRARIES = libemerillon.la
+
 
-emerillon_LDFLAGS = \
-	-export-dynamic
 
 BUILT_SOURCES =
 
-emerillon_SOURCES =	\
-	main.c		\
+libemerillon_la_SOURCES =	\
 	manager.h	\
 	manager.c	\
 	preferences.h	\
@@ -36,6 +33,13 @@ emerillon_SOURCES =	\
 	emerillon.h	\
 	$(BUILT_SOURCES)
 
+emerillon_SOURCES = main.c
+
+emerillon_CFLAGS = $(EOG_CFLAGS)
+emerillon_LDFLAGS = -export-dynamic
+
+emerillon_LDADD = libemerillon.la $(EMERILLON_LIBS)
+
 CLEANFILES = $(BUILT_SOURCES)
 
 headerdir = $(prefix)/include/emerillon- EMERILLON_API_VERSION@/emerillon
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]