[vlc-devel] commit: Add make doc and fix Doxygen from top_builddir ( Rémi Denis-Courmont )

[git version control]

vlc | branch: master | Rémi Denis-Courmont <rdenis at simphalempin.com> | Wed Aug 13 19:04:54 2008 +0300| [119a49ff66c87d570a9ed0fe76e74eb0dad0a622] | committer: Rémi Denis-Courmont 

Add make doc and fix Doxygen from top_builddir

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=119a49ff66c87d570a9ed0fe76e74eb0dad0a622
---

 Makefile.am                   |    5 ++++-
 doc/.gitignore                |    1 +
 doc/{Doxyfile => Doxyfile.in} |   16 ++++++++--------
 doc/Makefile.am               |   11 +++++++++--
 4 files changed, 22 insertions(+), 11 deletions(-)

diff --git a/Makefile.am b/Makefile.am
index f43e120..1caf4ee 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -316,7 +316,10 @@ libvlc:
 core:
 	cd src && $(MAKE) $(AM_MAKEFLAGS) vlc$(EXEEXT)
 
-.PHONY: libvlc core
+doc:
+	cd doc && $(MAKE) $(AM_MAKEFLAGS) doc
+
+.PHONY: libvlc core doc
 
 #To get some nice output
 nice:
diff --git a/doc/.gitignore b/doc/.gitignore
index b1cd668..b1a0012 100644
--- a/doc/.gitignore
+++ b/doc/.gitignore
@@ -1,3 +1,4 @@
 ChangeLog-*
 vlc.tags
+Doxyfile
 doxygen
diff --git a/doc/Doxyfile b/doc/Doxyfile.in
similarity index 99%
rename from doc/Doxyfile
rename to doc/Doxyfile.in
index 30b40ec..aefc323 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile.in
@@ -23,7 +23,7 @@ PROJECT_NAME           = VLC
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 
-PROJECT_NUMBER         = 
+PROJECT_NUMBER         = @VERSION@
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 
@@ -450,9 +450,9 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = ../src \
-                         ../include \
-                         ../modules
+INPUT                  = @top_srcdir@/src \
+                         @top_srcdir@/include \
+                         @top_srcdir@/modules
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -473,7 +473,7 @@ RECURSIVE              = YES
 # excluded from the INPUT source files. This way you can easily exclude a 
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = ../src/extras
+EXCLUDE                = @top_srcdir@/src/extras
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
 # directories that are symbolic links (a Unix filesystem feature) are excluded 
@@ -521,7 +521,7 @@ IMAGE_PATH             =
 # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
 # ignored.
 
-INPUT_FILTER           = "../toolbox --add-include"
+INPUT_FILTER           = "@top_srcdir@/toolbox --add-include"
 
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
 # basis.  Doxygen will compare the file name with each pattern and apply the 
@@ -971,8 +971,8 @@ SEARCH_INCLUDES        = YES
 # contain include files that are not input files but should be processed by 
 # the preprocessor.
 
-INCLUDE_PATH           = ../include \
-                         ../include/vlc
+INCLUDE_PATH           = @top_srcdir@/include \
+                         @top_srcdir@/include/vlc
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
 # patterns (like *.h and *.hpp) to filter out the header-files in the 
diff --git a/doc/Makefile.am b/doc/Makefile.am
index d16c337..8a34727 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -32,6 +32,7 @@ EXTRA_DIST = \
 	intf-vcd.txt \
 	release-howto.txt \
 	arm-crosscompile-howto.sgml \
+	Doxyfile.in \
 	Configure.help \
 	lirc/example.lircrc \
 	skins/skins-howto.txt \
@@ -47,7 +48,13 @@ EXTRA_DIST = \
 	demo.sh \
 	$(NULL)
 
-DISTCLEANFILES = $(CHANGELOGS)
+DISTCLEANFILES = $(CHANGELOGS) Doxyfile
+
+Doxyfile: Doxyfile.in $(top_builddir)/config.status
+	cd $(top_builddir) && $(SHELL) ./config.status --file=$(subdir)/$@
+
+doc: Doxyfile
+	doxygen
 
 $(CHANGELOGS): Makefile.am
 	if test -d "$(top_srcdir)/.git"; then \
@@ -59,7 +66,7 @@ $(CHANGELOGS): Makefile.am
 	fi
 
 # This one needs to be rebuilt all the time :)
-.PHONY: ChangeLog-2008 changelogs
+.PHONY: ChangeLog-2008 changelogs doc
 
 changelogs: $(CHANGELOGS)