[llvm-commits] CVS: llvm/docs/doxygen.cfg

Misha Brukman brukman at cs.uiuc.edu
Fri Oct 17 18:01:01 PDT 2003


Changes in directory llvm/docs:

doxygen.cfg updated: 1.5 -> 1.6

---
Log message:

* Align comments into 80 columns
* Stop using full pathnames (we don't know where the source could be)
* Use only relative distance to the source, so a user can download the code and
  generate their own copy of the doxygen documentation easily
* Since `docs' has moved one level up, all relative path names lost a `..'


---
Diffs of the changes:  (+17 -18)

Index: llvm/docs/doxygen.cfg
diff -u llvm/docs/doxygen.cfg:1.5 llvm/docs/doxygen.cfg:1.6
--- llvm/docs/doxygen.cfg:1.5	Thu Sep 26 11:45:59 2002
+++ llvm/docs/doxygen.cfg	Fri Oct 17 18:00:03 2003
@@ -100,10 +100,10 @@
 
 ALWAYS_DETAILED_SEC    = NO
 
-# 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 those members were 
-# ordinary class members. Constructors, destructors and assignment operators of 
-# the base classes will not be shown.
+# 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 those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
 
 INLINE_INHERITED_MEMB  = NO
 
@@ -111,15 +111,14 @@
 # path before files name in the file list and in the header files. If set 
 # to NO the shortest path that makes the file name unique will be used.
 
-FULL_PATH_NAMES        = YES
+FULL_PATH_NAMES        = NO
 
 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
 # can be used to strip a user defined part of the path. Stripping is 
 # only done if one of the specified strings matches the left-hand part of 
 # the path. It is allowed to use relative paths in the argument list.
 
-STRIP_FROM_PATH        = /home/vadve/lattner/cvs/
-
+STRIP_FROM_PATH        = ../..
 
 # The INTERNAL_DOCS tag determines if documentation 
 # that is typed after a \internal command is included. If the tag is set 
@@ -297,12 +296,12 @@
 # configuration options related to the input files
 #---------------------------------------------------------------------------
 
-# The INPUT tag can be used to specify the files and/or directories that contain 
-# documented source files. You may enter file names like "myfile.cpp" or 
-# directories like "/usr/src/myproject". Separate the files or directories 
-# with spaces.
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories with
+# spaces.
 
-INPUT                  = ../..
+INPUT                  = ..
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -323,7 +322,7 @@
 # excluded from the INPUT source files. This way you can easily exclude a 
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                =  ../../test ../../include/boost
+EXCLUDE                =  ../test ../include/boost
 
 # If the value of the INPUT tag contains directories, you can use the 
 # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
@@ -697,7 +696,7 @@
 # contain include files that are not input files but should be processed by 
 # the preprocessor.
 
-INCLUDE_PATH           = ../../include
+INCLUDE_PATH           = ../include
 
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
 # patterns (like *.h and *.hpp) to filter out the header-files in the 
@@ -756,10 +755,10 @@
 # Configuration options related to the dot tool   
 #---------------------------------------------------------------------------
 
-# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
-# generate a inheritance diagram (in Html, RTF and LaTeX) for classes with base or 
-# super classes. Setting the tag to NO turns the diagrams off. Note that this 
-# option is superceded by the HAVE_DOT option below. This is only a fallback. It is 
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will generate a
+# inheritance diagram (in Html, RTF and LaTeX) for classes with base or super
+# classes. Setting the tag to NO turns the diagrams off. Note that this option
+# is superceded by the HAVE_DOT option below. This is only a fallback. It is
 # recommended to install and use dot, since it yield more powerful graphs.
 
 CLASS_DIAGRAMS         = YES





More information about the llvm-commits mailing list