Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove last references to the now obsolete testsuite/ directory.
[simgrid.git] / doc / Doxyfile.in
index 605b62e..302af79 100644 (file)
@@ -116,7 +116,7 @@ ALWAYS_DETAILED_SEC    = NO
 # members were ordinary class members. Constructors, destructors and assignment
 # operators of the base classes will not be shown.
 
-INLINE_INHERITED_MEMB  = YES
+INLINE_INHERITED_MEMB  = NO
 
 # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
 # path before files name in the file list and in the header files. If set
@@ -131,7 +131,7 @@ FULL_PATH_NAMES        = YES
 # If left blank the directory from which doxygen is run is used as the
 # path to strip.
 
-STRIP_FROM_PATH        = @srcdir@
+STRIP_FROM_PATH        = @top_srcdir@
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
 # the path mentioned in the documentation of a class, which tells
@@ -196,7 +196,7 @@ TAB_SIZE               = 8
 # will result in a user-defined paragraph with heading "Side Effects:".
 # You can put \n's in the value part of an alias to insert newlines.
 
-ALIASES                =
+ALIASES                = SimGridRelease="SimGrid-@release_version@"
 
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
 # A mapping has the form "name=value". For example adding
@@ -322,22 +322,6 @@ INLINE_SIMPLE_STRUCTS  = NO
 
 TYPEDEF_HIDES_STRUCT   = NO
 
-# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
-# determine which symbols to keep in memory and which to flush to disk.
-# When the cache is full, less often used symbols will be written to disk.
-# For small to medium size projects (<1000 input files) the default value is
-# probably good enough. For larger projects a too small cache size can cause
-# doxygen to be busy swapping symbols to and from disk most of the time
-# causing a significant performance penalty.
-# If the system has enough physical memory increasing the cache will improve the
-# performance by keeping more symbols in memory. Note that the value works on
-# a logarithmic scale so increasing the size by one will roughly double the
-# memory usage. The cache size is given by this formula:
-# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
-# corresponding to a cache size of 2^16 = 65536 symbols.
-
-SYMBOL_CACHE_SIZE      = 0
-
 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
 # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
 # their name and scope. Since this can be an expensive process and often the
@@ -515,7 +499,7 @@ STRICT_PROTO_MATCHING  = NO
 # disable (NO) the todo list. This list is created by putting \todo
 # commands in the documentation.
 
-GENERATE_TODOLIST      = YES
+GENERATE_TODOLIST      = NO
 
 # The GENERATE_TESTLIST tag can be used to enable (YES) or
 # disable (NO) the test list. This list is created by putting \test
@@ -527,7 +511,7 @@ GENERATE_TESTLIST      = YES
 # disable (NO) the bug list. This list is created by putting \bug
 # commands in the documentation.
 
-GENERATE_BUGLIST       = YES
+GENERATE_BUGLIST       = NO
 
 # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
 # disable (NO) the deprecated list. This list is created by putting
@@ -617,7 +601,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   = 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
@@ -632,7 +616,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
@@ -671,10 +655,40 @@ INPUT                  = doxygen/index.doc \
                            doxygen/pls.doc \
                            doxygen/bindings.doc \
                           doxygen/internals.doc \
-                          doxygen/involved.doc \
-                         doxygen/examples.doc \            
+                            doxygen/inside_doxygen.doc \
+                            doxygen/inside_extending.doc \
+                            doxygen/inside_cmake.doc \
+                            doxygen/inside_autotests.doc \
+                            doxygen/inside_release.doc \
+                          doxygen/contributing.doc \
                          doxygen/tracing.doc \
-                        doxygen/FAQ.doc
+                        doxygen/FAQ.doc \
+                        doxygen/modules.doc \
+                           doxygen/module-xbt.doc \
+                           doxygen/module-msg.doc \
+                           doxygen/module-sd.doc \
+                           doxygen/module-surf.doc \
+                           doxygen/module-simix.doc \
+                           doxygen/module-smpi.doc \
+                           doxygen/module-trace.doc \
+                           index-API.doc \
+                         @top_srcdir@/doc/doxygen/logcategories.doc \
+                         @top_srcdir@/src/instr/ \
+                         @bindir@/include \
+                         @top_srcdir@/include/ \
+                         @top_srcdir@/include/msg \
+                         @top_srcdir@/include/xbt \
+                         @top_srcdir@/include/simdag \
+                         @top_srcdir@/include/simgrid \
+                         @top_srcdir@/src/include/surf \
+                         @top_srcdir@/src/xbt/ \
+                         @top_srcdir@/src/surf/ \
+                         @top_srcdir@/src/surf/plugins/ \
+                         @top_srcdir@/src/msg/ \
+                         @top_srcdir@/src/simdag \
+                         @top_srcdir@/src/simix \
+                         @bindir@/src
+
 
 ###################################################
 ##  PLEASE DON'T MESS WITH THE ORDER OF EXAMPLES ## (unless you know what you are doing, of course)
@@ -682,7 +696,6 @@ INPUT                  = doxygen/index.doc \
 
 INPUT +=                 @top_srcdir@/examples/msg/sendrecv/sendrecv.c \
                          @top_srcdir@/examples/msg/masterslave/masterslave_forwarder.c \
-                         @top_srcdir@/examples/msg/masterslave/masterslave_console.c \
                          @top_srcdir@/examples/msg/migration \
                          @top_srcdir@/examples/msg/suspend \
                          @top_srcdir@/examples/msg/properties \
@@ -738,7 +751,7 @@ RECURSIVE              = NO
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                =
+EXCLUDE                = @top_srcdir@/src/simix/simcalls_generated_case.c
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -769,8 +782,7 @@ EXCLUDE_SYMBOLS        =
 EXAMPLE_PATH           = ./ \
                          @top_srcdir@/src/surf/ \
                          @top_srcdir@/src/xbt/ \
-                         @top_srcdir@/examples \
-                         @top_srcdir@/testsuite
+                         @top_srcdir@/examples
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -1253,7 +1265,7 @@ MATHJAX_EXTENSIONS     =
 # typically be disabled. For large projects the javascript based search engine
 # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
 
-SEARCHENGINE           = NO
+SEARCHENGINE           = YES
 
 # When the SERVER_BASED_SEARCH tag is enabled the search engine will be
 # implemented using a PHP enabled web server instead of at the web client
@@ -1567,7 +1579,11 @@ INCLUDE_FILE_PATTERNS  =
 
 PREDEFINED             = DOXYGEN \
                          DOXYGEN_SKIP_IT \
-                         XBT_PUBLIC= \
+                         XBT_PUBLIC(type)="extern type" \
+                         XBT_EXPORT_NO_IMPORT(type)=type \
+                         XBT_IMPORT_NO_EXPORT(type)=type \
+                         XBT_PUBLIC_DATA(type)="extern type" \
+                         XBT_PUBLIC_CLASS=class \
                          XBT_INLINE= \
                          HAVE_TRACING \
                          MSG_USE_DEPRECATED
@@ -1604,14 +1620,12 @@ SKIP_FUNCTION_MACROS   = YES
 # NOT include the path). If a tag file is not located in the directory in which
 # doxygen is run, you must also specify the path to the tagfile here.
 
-TAGFILES               = shared/doxygen/simgridrefguide.tag=ref_guide/html/ \ 
-                         shared/doxygen/simgriddevguide.tag=dev_guide/html/
+TAGFILES               = 
 
 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
 # a tag file that is based on the input files it reads.
 
-#GENERATE_TAGFILE       = simgrid.tag 
-GENERATE_TAGFILE       = 
+GENERATE_TAGFILE       = simgrid.tag 
 
 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
 # in the class index. If set to NO only the inherited external classes