Turn off Doxygen warnings for undocumented API, for now.
authorJamey Sharp <jamey@minilop.net>
Sun, 19 Nov 2006 00:51:01 +0000 (16:51 -0800)
committerJamey Sharp <jamey@minilop.net>
Sun, 19 Nov 2006 00:51:01 +0000 (16:51 -0800)
But warn about absent parameter documentation for functions that are
otherwise documented.

xcb.doxygen

index ff80d14..1f4bb73 100644 (file)
@@ -418,7 +418,8 @@ WARNINGS               = YES
 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
 # automatically be disabled.
 
-WARN_IF_UNDOCUMENTED   = YES
+# XXX: In the future this should be turned on. For now it generates too much noise.
+WARN_IF_UNDOCUMENTED   = NO
 
 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
 # potential errors in the documentation, such as not documenting some
@@ -433,7 +434,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