[beast] DOCS: added development documentation build and upload rules



commit b888f05a8254831c90f65f9302145ed6b53aebfb
Author: Tim Janik <timj gtk org>
Date:   Thu May 5 02:56:05 2011 +0200

    DOCS: added development documentation build and upload rules

 docs/dev/.gitignore  |    2 +
 docs/dev/doxygen.cfg |   64 ++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/dev/makefile    |   27 +++++++++++++++++++++
 3 files changed, 93 insertions(+), 0 deletions(-)
---
diff --git a/docs/dev/.gitignore b/docs/dev/.gitignore
new file mode 100644
index 0000000..31af385
--- /dev/null
+++ b/docs/dev/.gitignore
@@ -0,0 +1,2 @@
+build-stamp
+html/
diff --git a/docs/dev/doxygen.cfg b/docs/dev/doxygen.cfg
new file mode 100644
index 0000000..6f0fd15
--- /dev/null
+++ b/docs/dev/doxygen.cfg
@@ -0,0 +1,64 @@
+PROJECT_NAME		= "BEAST/BSE - Better Audio System and Sound Engine - Source Code"
+OUTPUT_DIRECTORY	= doxyhtml/
+GENERATE_LATEX		= NO
+GENERATE_MAN		= NO
+GENERATE_RTF		= NO
+QUIET			= YES
+
+FULL_PATH_NAMES		= YES
+CASE_SENSE_NAMES	= NO
+RECURSIVE		= NO
+INPUT			= birnet/ sfi/ bse/ plugins/ plugins/freeverb/ beast-gtk/ launchers/ shell/ tools/
+FILE_PATTERNS		= *.idl *.c *.h *.cc *.hh *.proc
+EXCLUDE			=
+BUILTIN_STL_SUPPORT	= YES
+TYPEDEF_HIDES_STRUCT	= YES
+#EXAMPLE_PATH		= ../test
+#IMAGE_PATH		= pictures
+#INCLUDE_PATH		= /usr/include/
+
+EXTRACT_ALL		= NO
+EXTRACT_PRIVATE        = NO
+EXTRACT_STATIC		= NO
+EXTRACT_LOCAL_CLASSES	= NO
+EXTRACT_LOCAL_METHODS	= NO
+EXTRACT_ANON_NSPACES	= NO
+HIDE_UNDOC_MEMBERS	= NO
+HIDE_FRIEND_COMPOUNDS	= YES
+SHOW_INCLUDE_FILES	= NO
+JAVADOC_AUTOBRIEF	= NO
+INHERIT_DOCS		= YES
+ENABLED_SECTIONS	= ""
+MACRO_EXPANSION		= YES
+PREDEFINED		= DOXYGEN "ATTRIBUTE_UNUSED=" "link_warning(x,y)=" "G_BEGIN_DECLS=" "G_END_DECLS="
+INTERNAL_DOCS		= YES
+EXPAND_ONLY_PREDEF	= YES
+#ENABLE_PREPROCESSING	= YES
+
+#OPTIMIZE_OUTPUT_FOR_C	= YES
+
+#GENERATE_HTML          = YES
+#HTML_OUTPUT            = html
+#HTML_FILE_EXTENSION    = .html
+#HTML_HEADER            =
+#HTML_FOOTER            =
+#HTML_STYLESHEET        =
+#HTML_COLORSTYLE_HUE    = 220
+#HTML_COLORSTYLE_SAT    = 100
+#HTML_COLORSTYLE_GAMMA  = 80
+#HTML_TIMESTAMP         = YES
+#HTML_ALIGN_MEMBERS     = YES
+#HTML_DYNAMIC_SECTIONS  = NO
+
+HAVE_DOT		= YES
+UML_LOOK		= NO
+CLASS_GRAPH		= YES
+COLLABORATION_GRAPH	= YES
+GROUP_GRAPHS		= YES
+TEMPLATE_RELATIONS	= NO
+INCLUDE_GRAPH		= YES
+INCLUDED_BY_GRAPH	= YES
+GRAPHICAL_HIERARCHY	= YES
+DIRECTORY_GRAPH		= YES
+CALL_GRAPH		= NO
+CALLER_GRAPH		= YES
diff --git a/docs/dev/makefile b/docs/dev/makefile
new file mode 100644
index 0000000..dc00e74
--- /dev/null
+++ b/docs/dev/makefile
@@ -0,0 +1,27 @@
+# Build and upload development documentation
+
+all: build-stamp
+
+top_srcdir  = ../..
+git_stamp   = $(top_srcdir)/.git/$(shell git symbolic-ref -q HEAD)
+SED_VERSION = $(shell sed -ne "/^[ \t]*VERSION[ \t]*=/ { s/^[^=]*=[ \t]*//; p; q }" < $(top_srcdir)/Makefile)
+SED_MKEVEN  = sed 's/1$$/0/;s/3$$/2/;s/5$$/4/;s/7$$/6/;s/9$$/8/'
+
+build-stamp: $(git_stamp) doxygen.cfg
+	rm -rf html/
+	cd $(top_srcdir) \
+	&& (cat docs/dev/doxygen.cfg \
+	&& echo "STRIP_FROM_PATH = `pwd`" \
+	&& echo "OUTPUT_DIRECTORY = docs/dev/html/" \
+	&& echo -n "PROJECT_NUMBER = $(SED_VERSION)" \
+	) | nice doxygen -
+	mv html/html/ html/$(SED_VERSION)/
+	ln -s $(SED_VERSION) html/latest
+	touch $@
+
+upload: all
+	rsync -aHP --del '--filter=P /*/' html/  dev.testbit.eu:/srv/dev/html/beast/
+
+clean:
+	rm -f build-stamp
+	rm -rf html/



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]