Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : remove local variable only if frame name is known
[simgrid.git] / doc / Doxyfile.in
index 6c231fd..b399a5c 100644 (file)
@@ -41,7 +41,7 @@ PROJECT_NUMBER         = @release_version@
 # for a project that appears at the top of each page and should give viewer
 # a quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "Scalable simulation of distributed systems"
+PROJECT_BRIEF          = "Versatile Simulation of Distributed Systems"
 
 # With the PROJECT_LOGO tag one can specify an logo or icon that is
 # included in the documentation. The maximum height of the logo should not
@@ -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
@@ -515,7 +515,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 +527,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
@@ -586,7 +586,7 @@ FILE_VERSION_FILTER    =
 # You can optionally specify a file name after the option, if omitted
 # DoxygenLayout.xml will be used as the name of the layout file.
 
-LAYOUT_FILE            = SimgridDoxygenLayout.xml
+LAYOUT_FILE            = Layout.xml
 
 # The CITE_BIB_FILES tag can be used to specify one or more bib files
 # containing the references data. This must be a list of .bib files. The
@@ -617,7 +617,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 +632,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
@@ -658,9 +658,81 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = index.doc \
-                         FAQ.doc
-                         
+INPUT                  = doxygen/index.doc \
+                         doxygen/getting_started.doc \
+                         doxygen/introduction.doc \
+                         doxygen/install.doc \
+                         doxygen/use.doc \   
+                           doxygen/platform.doc \
+                           doxygen/deployment.doc \
+                           doxygen/options.doc \
+                           doxygen/help.doc \
+                        doxygen/advanced.doc \
+                           doxygen/pls.doc \
+                           doxygen/bindings.doc \
+                          doxygen/internals.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/modules.doc \
+                           doxygen/module-xbt.doc \
+                           doxygen/module-msg.doc \
+                           doxygen/module-sd.doc \
+                           doxygen/module-surf.doc \
+                           doxygen/module-simix.doc \
+                           doxygen/module-trace.doc \
+                           index-API.doc \
+                         @top_srcdir@/doc/doxygen/logcategories.doc \
+                         @top_srcdir@/src/instr/ \
+                         @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/msg/ \
+                         @top_srcdir@/src/simdag \
+                         @top_srcdir@/src/simix
+
+
+###################################################
+##  PLEASE DON'T MESS WITH THE ORDER OF EXAMPLES ## (unless you know what you are doing, of course)
+###################################################
+
+INPUT +=                 @top_srcdir@/examples/msg/sendrecv/sendrecv.c \
+                         @top_srcdir@/examples/msg/masterslave/masterslave_forwarder.c \
+                         @top_srcdir@/examples/msg/migration \
+                         @top_srcdir@/examples/msg/suspend \
+                         @top_srcdir@/examples/msg/properties \
+                         @top_srcdir@/examples/msg/parallel_task \
+                         @top_srcdir@/examples/msg/priority \
+                         @top_srcdir@/examples/msg/icomms/peer.c \
+                         @top_srcdir@/examples/msg/icomms/peer2.c \
+                         @top_srcdir@/examples/msg/icomms/peer3.c \
+                         @top_srcdir@/examples/msg/tracing/simple.c \
+                         @top_srcdir@/examples/msg/tracing/ms.c \
+                         @top_srcdir@/examples/msg/tracing/categories.c \
+                         @top_srcdir@/examples/msg/tracing/procmig.c \
+                         @top_srcdir@/examples/msg/tracing/trace_platform.c \
+                         @top_srcdir@/examples/msg/tracing/user_variables.c \
+                         @top_srcdir@/examples/msg/tracing/link_user_variables.c \
+                         @top_srcdir@/examples/msg/tracing/link_srcdst_user_variables.c \
+                         @top_srcdir@/examples/msg/ns3 \
+                         @top_srcdir@/examples/msg/gtnets \
+                         @top_srcdir@/examples/msg/io \
+                         @top_srcdir@/examples/msg/gpu \
+                         @top_srcdir@/examples/msg/actions \
+                         @top_srcdir@/examples/msg/token_ring \
+                         @top_srcdir@/examples/msg/pmm \
+                         @top_srcdir@/examples/msg/chord
+
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
 # also the default input encoding. Doxygen uses libiconv (or the iconv built
@@ -720,7 +792,6 @@ EXCLUDE_SYMBOLS        =
 # the \include command).
 
 EXAMPLE_PATH           = ./ \
-                         @top_srcdir@/doc/gtut-files \
                          @top_srcdir@/src/surf/ \
                          @top_srcdir@/src/xbt/ \
                          @top_srcdir@/examples \
@@ -744,7 +815,8 @@ EXAMPLE_RECURSIVE      = YES
 # directories that contain image that are included in the documentation (see
 # the \image command).
 
-IMAGE_PATH             = @top_srcdir@/doc
+IMAGE_PATH             = @top_srcdir@/doc \
+                         @top_srcdir@/doc/webcruft
 
 # 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
@@ -893,13 +965,13 @@ HTML_FILE_EXTENSION    = .html
 # have to redo this when upgrading to a newer version of doxygen or when
 # changing the value of configuration settings such as GENERATE_TREEVIEW!
 
-HTML_HEADER            =
+HTML_HEADER            = doxygen/header.html 
 
 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 # each generated HTML page. If it is left blank doxygen will generate a
 # standard footer.
 
-HTML_FOOTER            = 
+HTML_FOOTER            = doxygen/footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
 # style sheet that is used by each HTML page. It can be used to
@@ -908,7 +980,7 @@ HTML_FOOTER            =
 # the style sheet file to the HTML output directory, so don't put your own
 # style sheet in the HTML output directory as well, or it will be erased!
 
-HTML_STYLESHEET        =
+HTML_STYLESHEET        = doxygen/stylesheet.css
 
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note
@@ -1124,7 +1196,7 @@ ECLIPSE_DOC_ID         = org.doxygen.Project
 # navigation tree you can set this option to NO if you already set
 # GENERATE_TREEVIEW to YES.
 
-DISABLE_INDEX          = NO
+DISABLE_INDEX          = YES
 
 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
 # structure should be generated to display hierarchical information.
@@ -1136,7 +1208,7 @@ DISABLE_INDEX          = NO
 # Since the tree basically has the same information as the tab index you
 # could consider to set DISABLE_INDEX to NO when enabling this option.
 
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = YES
 
 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
 # (range [0,1..20]) that doxygen will group on one line in the generated HTML
@@ -1206,7 +1278,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
@@ -1302,7 +1374,7 @@ LATEX_BATCHMODE        = NO
 # include the index chapters (such as File Index, Compound Index, etc.)
 # in the output.
 
-LATEX_HIDE_INDICES     = NO
+LATEX_HIDE_INDICES     = YES
 
 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
 # source code with syntax highlighting in the LaTeX output.
@@ -1557,9 +1629,7 @@ 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/simgriduserguide.tag=user_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.