PUD: update doc makefiles
authorFerry Huberts <ferry.huberts@pelagic.nl>
Fri, 5 Aug 2011 12:07:37 +0000 (14:07 +0200)
committerFerry Huberts <f.huberts@mindef.nl>
Thu, 18 Aug 2011 13:02:25 +0000 (15:02 +0200)
Signed-off-by: Ferry Huberts <ferry.huberts@pelagic.nl>
lib/pud/doc/.gitignore
lib/pud/doc/Makefile
lib/pud/doc/doxygen.conf

index de31ec3..cebfb10 100644 (file)
@@ -1,4 +1,5 @@
 /html/
+/man/
 /latex/
-/olsrd_pud.pdf
 /doxygen.conf.temp
+/olsrd_pud.pdf
index 456ea32..054abcc 100644 (file)
@@ -1,18 +1,34 @@
 include ../Makefile.inc
 
-.PHONY: all clean
+HTML_DIR = html
+MAN_DIR = man
+LATEX_DIR = latex
+PDF_NAME = $(PLUGIN_NAME).pdf
+DOX_FILE = doxygen.conf
+TMP_DOX_FILE = $(DOX_FILE).temp
+
+.PHONY: .gitignore all clean
+
+.gitignore:
+       @echo "[$@] doc"
+       @echo "/$(HTML_DIR)/" > $@
+       @echo "/$(MAN_DIR)/" >> $@
+       @echo "/$(LATEX_DIR)/" >> $@
+       @echo "/$(TMP_DOX_FILE)" >> $@
+       @echo "/$(PDF_NAME)" >> $@
 
 clean:
-       rm -fr html latex $(PLUGIN_NAME).pdf
+       @echo "[$@] doc"
+       @rm -fr "$(HTML_DIR)" "$(LATEX_DIR)" "$(MAN_DIR)" "$(PDF_NAME)"
 
-all: clean doxygen.conf
-       @echo "Updating version..."
-       @sed -r "s/^([[:space:]]*PROJECT_NUMBER[[:space:]]*=).*/\1 $(VERSION)/" doxygen.conf > doxygen.conf.temp
-       @echo "Generating HTML pages..."
-       @doxygen doxygen.conf.temp
-       @rm doxygen.conf.temp
-       @echo "Generating PDF..."
-       @make -C latex -s > /dev/null 2>&1
-       @mv latex/refman.pdf $(PLUGIN_NAME).pdf
-       @rm -fr latex
-       @echo "Done"
+all: clean $(DOX_FILE)
+       @echo "[$@] doc"
+       @sed \
+         -e "s/__PLUGIN_VER__/$(PLUGIN_VER)/" \
+         -e "s/__LIBNAME__/$(PLUGIN_NAME)/" \
+         "$(DOX_FILE)" > "$(TMP_DOX_FILE)"
+       @doxygen "$(TMP_DOX_FILE)"
+       @rm "$(TMP_DOX_FILE)"
+       @$(MAKE) -s -C $(LATEX_DIR) all > /dev/null 2>&1
+       @mv "$(LATEX_DIR)/refman.pdf" "$(PDF_NAME)"
+       @rm -fr "$(LATEX_DIR)"
index 8f3e4a8..f3ecc07 100644 (file)
@@ -25,13 +25,13 @@ DOXYFILE_ENCODING      = UTF-8
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
 # by quotes) that should identify the project.
 
-PROJECT_NAME           = "Position Update Distribution"
+PROJECT_NAME           = "__LIBNAME__"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
 # if some version control system is used.
 
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = "__PLUGIN_VER__"
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.
@@ -908,7 +908,7 @@ GENERATE_HTMLHELP      = NO
 # can add a path in front of the file if the result should not be
 # written to the html output directory.
 
-CHM_FILE               =
+CHM_FILE               = __LIBNAME__.chm
 
 # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
 # be used to specify the location (absolute path including file name) of
@@ -1122,7 +1122,7 @@ COMPACT_LATEX          = NO
 # by the printer. Possible values are: a4, a4wide, letter, legal and
 # executive. If left blank a4wide will be used.
 
-PAPER_TYPE             = a4wide
+PAPER_TYPE             = a4
 
 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
 # packages that should be included in the LaTeX output.
@@ -1218,7 +1218,7 @@ RTF_EXTENSIONS_FILE    =
 # If the GENERATE_MAN tag is set to YES (the default) Doxygen will
 # generate man pages
 
-GENERATE_MAN           = NO
+GENERATE_MAN           = YES
 
 # The MAN_OUTPUT tag is used to specify where the man pages will be put.
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be