[beast] DOCS: auto include headers in docs, show files, dirs, includes



commit 941dcc1944a8d3280b1e4589ca28f3aa56f52d21
Author: Tim Janik <timj gtk org>
Date:   Fri May 6 03:25:45 2011 +0200

    DOCS: auto include headers in docs, show files, dirs, includes

 docs/dev/doxygen.cfg |   19 +++++++++++--------
 docs/dev/makefile    |   32 ++++++++++++++++++++++++++------
 2 files changed, 37 insertions(+), 14 deletions(-)
---
diff --git a/docs/dev/doxygen.cfg b/docs/dev/doxygen.cfg
index 6f0fd15..2b6d6ba 100644
--- a/docs/dev/doxygen.cfg
+++ b/docs/dev/doxygen.cfg
@@ -7,9 +7,8 @@ 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
+RECURSIVE		= YES
+FILE_PATTERNS		= *
 EXCLUDE			=
 BUILTIN_STL_SUPPORT	= YES
 TYPEDEF_HIDES_STRUCT	= YES
@@ -18,20 +17,24 @@ TYPEDEF_HIDES_STRUCT	= YES
 #INCLUDE_PATH		= /usr/include/
 
 EXTRACT_ALL		= NO
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE		= NO
 EXTRACT_STATIC		= NO
 EXTRACT_LOCAL_CLASSES	= NO
 EXTRACT_LOCAL_METHODS	= NO
 EXTRACT_ANON_NSPACES	= NO
+HIDE_IN_BODY_DOCS	= YES
+
+INTERNAL_DOCS		= NO
 HIDE_UNDOC_MEMBERS	= NO
 HIDE_FRIEND_COMPOUNDS	= YES
-SHOW_INCLUDE_FILES	= NO
+SHOW_USED_FILES 	= YES
+SHOW_DIRECTORIES 	= YES
+SHOW_INCLUDE_FILES	= YES
 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
 
@@ -56,9 +59,9 @@ CLASS_GRAPH		= YES
 COLLABORATION_GRAPH	= YES
 GROUP_GRAPHS		= YES
 TEMPLATE_RELATIONS	= NO
-INCLUDE_GRAPH		= YES
+INCLUDE_GRAPH		= NO
 INCLUDED_BY_GRAPH	= YES
 GRAPHICAL_HIERARCHY	= YES
 DIRECTORY_GRAPH		= YES
 CALL_GRAPH		= NO
-CALLER_GRAPH		= YES
+CALLER_GRAPH		= NO
diff --git a/docs/dev/makefile b/docs/dev/makefile
index dc00e74..010137b 100644
--- a/docs/dev/makefile
+++ b/docs/dev/makefile
@@ -7,14 +7,34 @@ 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/'
 
+DOC_DIRS   = birnet/ sfi/ bse/ plugins/ plugins/freeverb/ beast-gtk/ beast-gtk/gxk/ launchers/ shell/ tools/
+DOCU_GLOBS = *.idl *.h *.H *.hh *.proc
+DOXY_GLOBS = $(DOCU_GLOBS) *.c *.C *.cc
+SRCTREE    = srctree
+
 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/" \
+	rm -rf html/ $(SRCTREE)/
+	mkdir -p html/ $(SRCTREE)/
+	@echo "### Copying Source..."
+	CWD=`pwd` \
+	&& for dir in $(DOC_DIRS) ; do \
+	  (mkdir -p $$CWD/$(SRCTREE)/$$dir/ \
+	   && cd $(top_srcdir)/$$dir \
+	   && find . -maxdepth 1 -type f \( $(patsubst %,-name '%' -o, $(DOXY_GLOBS)) -false \) \
+	      -exec cp {} $$CWD/$(SRCTREE)/$$dir/{} \; ) \
+	  done
+	@echo "### Identifying Documentation files..."
+	cd $(SRCTREE)/ \
+	&& find . -type f \( $(patsubst %,-name '%' -o, $(DOCU_GLOBS)) -false \) \
+	   -exec sed  '1,+0s,^,/** @file {} */,' {} --in-place \;
+	@echo "### Doxygen..."
+	(cat doxygen.cfg \
+	&& echo "STRIP_FROM_PATH  = `pwd`/$(SRCTREE)" \
+	&& echo "INPUT		  = $(SRCTREE)/" \
+	&& echo "OUTPUT_DIRECTORY = html/" \
 	&& echo -n "PROJECT_NUMBER = $(SED_VERSION)" \
 	) | nice doxygen -
+	rm -rf $(SRCTREE)/
 	mv html/html/ html/$(SED_VERSION)/
 	ln -s $(SED_VERSION) html/latest
 	touch $@
@@ -24,4 +44,4 @@ upload: all
 
 clean:
 	rm -f build-stamp
-	rm -rf html/
+	rm -rf $(SRCTREE)/ html/



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