[fedfs-utils] [PATCH 2/8] doxy: Update some doxy.cfg settings

Chuck Lever chuck.lever at oracle.com
Wed Nov 28 17:49:42 PST 2012


Let's direct the warnings to a separate file: the output messages
blast by during a build so it's hard to see any problems.

Add the fedfs-utils revision number.

Enable warnings when a function parameter has no documentation.

Signed-off-by: Chuck Lever <chuck.lever at oracle.com>
---

 doxy.cfg |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doxy.cfg b/doxy.cfg
index 459bf46..6a5173e 100644
--- a/doxy.cfg
+++ b/doxy.cfg
@@ -48,7 +48,7 @@ PROJECT_NAME           = "Linux Federated File System Utilities"
 # This could be handy for archiving the generated documentation or
 # if some version control system is used.
 
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = 0.9
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.
@@ -565,7 +565,7 @@ WARN_IF_DOC_ERROR      = YES
 # wrong or incomplete parameter documentation, but not about the absence of
 # documentation.
 
-WARN_NO_PARAMDOC       = NO
+WARN_NO_PARAMDOC       = YES
 
 # The WARN_FORMAT tag determines the format of the warning messages that
 # doxygen can produce. The string should contain the $file, $line, and $text
@@ -580,7 +580,7 @@ WARN_FORMAT            = "$file:$line: $text"
 # and error messages should be written. If left blank the output is written
 # to stderr.
 
-WARN_LOGFILE           =
+WARN_LOGFILE           = /tmp/doxy.out
 
 #---------------------------------------------------------------------------
 # configuration options related to the input files




More information about the fedfs-utils-devel mailing list