changeset 2033:34299070db29 trunk

[svn] - make documentation-build will invoke gtk-doc to compile the audacious SDK docs.
author nenolod
date Sun, 03 Dec 2006 23:26:42 -0800
parents 7aed5cf10141
children c43fb0845b71
files ChangeLog Makefile
diffstat 2 files changed, 56 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog	Sun Dec 03 22:35:18 2006 -0800
+++ b/ChangeLog	Sun Dec 03 23:26:42 2006 -0800
@@ -1,3 +1,11 @@
+2006-12-04 06:35:18 +0000  William Pitcock <nenolod@nenolod.net>
+  revision [3067]
+  - document the VFS layer.
+  
+  trunk/libaudacious/vfs.c |  248 ++++++++++++++++++++++++++++++++++++++++++++---
+  1 file changed, 237 insertions(+), 11 deletions(-)
+
+
 2006-12-02 07:29:36 +0000  William Pitcock <nenolod@nenolod.net>
   revision [3065]
   - don't leak the split URI vector after doing the vtable lookup
--- a/Makefile	Sun Dec 03 22:35:18 2006 -0800
+++ b/Makefile	Sun Dec 03 23:26:42 2006 -0800
@@ -23,3 +23,51 @@
 	audtool.1:$(mandir)/man1					\
 	audacious/audacious.desktop:$(datadir)/applications
 
+build-posthook:
+	@( \
+		echo; \
+		echo "Now type '$(MAKE) documentation-build' to build the audacious SDK docs."; \
+		echo "This will require GTK-DOC to be installed."; \
+		echo; \
+	);
+
+documentation-build:
+	( \
+		if [ ! -d doc ]; then \
+			mkdir -p doc/libaudacious/xml; \
+			mkdir -p doc/audacious/xml; \
+		fi; \
+		pushd doc/libaudacious > /dev/null; \
+			gtkdoc-scan --module=libaudacious --source-dir=../../libaudacious; \
+		popd > /dev/null; \
+		pushd doc/audacious > /dev/null; \
+			gtkdoc-scan --module=audacious --source-dir=../../audacious --ignore-headers=intl; \
+		popd > /dev/null; \
+		pushd doc/libaudacious > /dev/null; \
+			gtkdoc-mktmpl --module=libaudacious; \
+		popd > /dev/null; \
+		pushd doc/audacious > /dev/null; \
+			gtkdoc-mktmpl --module=audacious; \
+		popd > /dev/null; \
+		pushd doc/libaudacious > /dev/null; \
+			gtkdoc-mkdb --module=libaudacious --source-dir=../../libaudacious/ --output-format=xml --main-sgml-file=xml/libaudacious-main.sgml; \
+		popd > /dev/null; \
+		pushd doc/audacious > /dev/null; \
+			gtkdoc-mkdb --module=audacious --source-dir=../../audacious/ --ignore-files=intl --output-format=xml --main-sgml-file=xml/audacious-main.sgml; \
+		popd > /dev/null; \
+		rm -rf doc/libaudacious/html; \
+		mkdir -p doc/libaudacious/html; \
+		rm -rf doc/audacious/html; \
+		mkdir -p doc/audacious/html; \
+		pushd doc/libaudacious/html > /dev/null; \
+			gtkdoc-mkhtml libaudacious ../libaudacious-main.sgml; \
+		popd > /dev/null; \
+		pushd doc/audacious/html > /dev/null; \
+			rm ../xml/xml; \
+			ln -sf ../xml ../xml/xml; \
+			gtkdoc-mkhtml audacious ../xml/audacious-main.sgml; \
+		popd > /dev/null; \
+		echo; \
+		echo "The audacious SDK documentation was built successfully in doc/."; \
+		echo; \
+	);