Updated Doxygen documentation:

[u/mrichter/AliRoot.git] / MUON / Doxyfile

diff --git a/MUON/Doxyfile b/MUON/Doxyfile
index c8c8aceb729f78f04abe6481187b0a17ccd813b8..392d3c87814c59290d558dc4c1ffa13a042bd9d2 100644 (file)
--- a/MUON/Doxyfile
+++ b/MUON/Doxyfile
@@ -23,7 +23,7 @@ PROJECT_NAME           = "AliRoot MUON"
 # This could be handy for archiving the generated documentation or 
 # if some version control system is used.
 
-PROJECT_NUMBER         = "Version CVS"
+PROJECT_NUMBER         = "Version SVN trunk"
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
 # base path where the generated documentation will be put. 
@@ -76,13 +76,13 @@ REPEAT_BRIEF           = YES
 # name of the entity): "The $name class" "The $name widget" "The $name file" 
 # "is" "provides" "specifies" "contains" "represents" "a" "an" "the"
 
-ABBREVIATE_BRIEF       = 
+ABBREVIATE_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 those members were 
@@ -203,6 +203,7 @@ SUBGROUPING            = YES
 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
 
 EXTRACT_ALL            = YES
+#EXTRACT_ALL            = NO
 
 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
 # will be included in the documentation.
@@ -382,6 +383,7 @@ WARNINGS               = YES
 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
 # automatically be disabled.
 
+#WARN_IF_UNDOCUMENTED   = YES
 WARN_IF_UNDOCUMENTED   = YES
 
 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
@@ -413,7 +415,8 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = . ../STEER ../EVGEN
+INPUT                  = . ../STEER ../EVGEN ../EVE/macros/alieve_init.C ../EVE/alice-macros/event_goto.C ../EVE/macros/muon_init.C ../EVE/alice-macros/esd_muon_tracks.C ../EVE/alice-macros/geom_gentle_muon.C ../EVE/alice-macros/muon_clusters.C ../EVE/alice-macros/muon_digits.C ../EVE/alice-macros/muon_raw.C ../EVE/alice-macros/muon_trackRefs.C ../EVE/alice-macros/MUON_displayData.C ../EVE/alice-macros/MUON_displaySimu.C  ../EVE/alice-macros/MUON_geomAll.C  ../EVE/alice-macros/MUON_geom.C  ../EVE/alice-macros/MUON_makeGeom.C
+#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 
@@ -422,7 +425,7 @@ INPUT                  = . ../STEER ../EVGEN
 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp 
 # *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm
 
-FILE_PATTERNS          = *.h *.cxx *.icc
+FILE_PATTERNS          = *.h *.cxx *.icc *.C README*.txt *.sh
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
 # should be searched for input files as well. Possible values are YES and NO. 
@@ -434,7 +437,7 @@ RECURSIVE              = YES
 # 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                = tgt_linux mapping.new mapping.fromLaurent.0 untar
+EXCLUDE                = check muon_html test_out.100 tgt_linux 
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
@@ -471,7 +474,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see 
 # the \image command).
 
-IMAGE_PATH             = 
+IMAGE_PATH             = .
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
 # invoke to filter for each input file. Doxygen will invoke the filter program 
@@ -530,7 +533,7 @@ REFERENCED_BY_RELATION = YES
 # then for each documented function all documented entities 
 # called/used by that function will be listed.
 
-REFERENCES_RELATION    = YES
+REFERENCES_RELATION    = NO
 
 # 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 
@@ -574,7 +577,7 @@ GENERATE_HTML          = YES
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
 # put in front of it. If left blank `html' will be used as the default path.
 
-HTML_OUTPUT            = html
+HTML_OUTPUT            = muon_html
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank