Browse Source

[1531] Changes after Jeremy's review.

Tomek Mrugalski 13 years ago
parent
commit
fbe7a931b3
3 changed files with 13 additions and 5 deletions
  1. 6 2
      doc/Doxyfile
  2. 5 2
      doc/Makefile.am
  3. 2 1
      doc/devel/mainpage.dox

+ 6 - 2
doc/Doxyfile

@@ -25,13 +25,17 @@ DOXYFILE_ENCODING      = UTF-8
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
 # by quotes) that should identify the project.
 # by quotes) that should identify the project.
 
 
-PROJECT_NAME           = BIND
+PROJECT_NAME           = BIND10
 
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
 # This could be handy for archiving the generated documentation or
 # if some version control system is used.
 # if some version control system is used.
 
 
-PROJECT_NUMBER         = 10.0.0
+# Currently this variable is overwritten (see devel target in Makefile.am)
+# If the number of paramters to overwrite increases, we should generate
+# Doxyfile (rename it to Doxyfile.in and generate during configure phase)
+
+PROJECT_NUMBER         =
 
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.
 # base path where the generated documentation will be put.

+ 5 - 2
doc/Makefile.am

@@ -4,8 +4,11 @@ EXTRA_DIST = version.ent.in
 
 
 devel:
 devel:
 	mkdir -p html
 	mkdir -p html
-	doxygen Doxyfile > html/doxygen.log 2> html/doxygen-error.log
-	echo "`wc -l html/doxygen-error.log` warnings/errors detected."
+	(cat Doxyfile; echo PROJECT_NUMBER=$(PACKAGE_VERSION)) | doxygen - > html/doxygen.log 2> html/doxygen-error.log
+	echo `grep -i ": warning:" html/doxygen-error.log | wc -l` warnings/errors detected.
+
+clean:
+	rm -rf html
 
 
 # That's a bit of a hack, but we are making sure that devel target
 # That's a bit of a hack, but we are making sure that devel target
 # is always valid. The alternative is to make devel depend on all
 # is always valid. The alternative is to make devel depend on all

+ 2 - 1
doc/devel/mainpage.dox

@@ -8,7 +8,8 @@
  * for existing and prospective contributors.
  * for existing and prospective contributors.
  *
  *
  * If you are a user or system administrator, rather than software engineer,
  * If you are a user or system administrator, rather than software engineer,
- * you should read BIND10 Guide (Administrator Reference for BIND10) instead.
+ * you should read <a href="http://bind10.isc.org/docs/bind10-guide.html">BIND10
+ * Guide (Administrator Reference for BIND10)</a> instead.
  *
  *
  * Regardless of your field of expertise, you are encouraged to visit
  * Regardless of your field of expertise, you are encouraged to visit
  * <a href="http://bind10.isc.org/">BIND10 webpage (http://bind10.isc.org)</a>
  * <a href="http://bind10.isc.org/">BIND10 webpage (http://bind10.isc.org)</a>