[llvm-commits] [hlvm] r38196 - /hlvm/trunk/docs/Doxyfile.in

Reid Spencer reid at x10sys.com
Sat Jul 7 17:01:03 PDT 2007


Author: reid
Date: Sat Jul  7 19:01:03 2007
New Revision: 38196

URL: http://llvm.org/viewvc/llvm-project?rev=38196&view=rev
Log:
Adjust doxygen options a little for better looking documentation.

Modified:
    hlvm/trunk/docs/Doxyfile.in

Modified: hlvm/trunk/docs/Doxyfile.in
URL: http://llvm.org/viewvc/llvm-project/hlvm/trunk/docs/Doxyfile.in?rev=38196&r1=38195&r2=38196&view=diff

==============================================================================
--- hlvm/trunk/docs/Doxyfile.in (original)
+++ hlvm/trunk/docs/Doxyfile.in Sat Jul  7 19:01:03 2007
@@ -79,7 +79,7 @@
 # If set to NO (the default) these class will be included in the various 
 # overviews. This option has no effect if EXTRACT_ALL is enabled.
 
-HIDE_UNDOC_CLASSES     = YES
+HIDE_UNDOC_CLASSES     = NO
 
 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
 # friend (class|struct|union) declarations. 
@@ -107,13 +107,13 @@
 # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
 # brief descriptions will be completely suppressed.
 
-REPEAT_BRIEF           = NO
+REPEAT_BRIEF           = YES
 
 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
 # Doxygen will generate a detailed section even if there is only a brief 
 # description.
 
-ALWAYS_DETAILED_SEC    = NO
+ALWAYS_DETAILED_SEC    = YES
 
 # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
 # inherited members of a class in the documentation of that class as if 
@@ -160,7 +160,7 @@
 # will show members with their full class and namespace scopes in the 
 # documentation. If set to YES the scope will be hidden.
 
-HIDE_SCOPE_NAMES       = NO
+HIDE_SCOPE_NAMES       = YES
 
 # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
 # will generate a verbatim copy of the header file for each class for 
@@ -225,7 +225,7 @@
 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
 # Doxygen uses this value to replace tabs by spaces in code fragments.
 
-TAB_SIZE               = 8
+TAB_SIZE               = 2
 
 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
 # disable (NO) the todo list. This list is created by putting \todo 
@@ -314,7 +314,7 @@
 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
 # automatically be disabled.
 
-WARN_IF_UNDOCUMENTED   = NO
+WARN_IF_UNDOCUMENTED   = YES
 
 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
 # potential errors in the documentation, such as not documenting some 
@@ -1005,3 +1005,4 @@
 # used. If set to NO the values of all tags below this one will be ignored.
 
 SEARCHENGINE           = NO
+





More information about the llvm-commits mailing list