# 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
# 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
# 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
# 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
# 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 = DoxygenLayoutSimgrid.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
# 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
# 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
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = index.doc \
- FAQ.doc \
- install.doc \
- bindings.doc \
- options.doc \
- tracing.doc \
- platform.doc \
- use.doc \
- pls.doc \
- ./index-API.doc \
- modules.doc \
- module-xbt.doc \
- module-msg.doc \
- module-gras.doc \
- module-amok.doc \
- module-sd.doc \
- module-surf.doc \
- module-trace.doc \
- gtut-main.doc \
- gtut-introduction.doc \
- gtut-tour.doc \
- gtut-tour-00-install.doc \
- gtut-tour-01-bones.doc \
- gtut-tour-02-simple.doc \
- gtut-tour-03-args.doc \
- gtut-tour-04-callback.doc \
- gtut-tour-05-globals.doc \
- gtut-tour-06-logs.doc \
- gtut-tour-07-timers.doc \
- gtut-tour-08-exceptions.doc \
- gtut-tour-09-simpledata.doc \
- gtut-tour-10-rpc.doc \
- gtut-tour-11-explicitwait.doc \
- gtut-tour-recap-messages.doc \
- gtut-tour-12-staticstruct.doc \
- gtut-tour-13-pointers.doc \
- gtut-tour-14-dynar.doc \
- gtut-tour-15-manualdatadef.doc \
- gtut-tour-16-exchangecb.doc \
- gtut-howto.doc \
- gtut-howto-design.doc \
- @top_srcdir@/doc/logcategories.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/gras \
- @top_srcdir@/include/amok \
@top_srcdir@/include/xbt \
@top_srcdir@/include/simdag \
@top_srcdir@/include/simgrid \
@top_srcdir@/src/include/surf \
@top_srcdir@/src/xbt/ \
- @top_srcdir@/src/xbt/datadesc \
@top_srcdir@/src/surf/ \
@top_srcdir@/src/msg/ \
- @top_srcdir@/src/gras \
- @top_srcdir@/src/gras/Msg \
- @top_srcdir@/src/gras/Transport \
- @top_srcdir@/src/gras/Virtu \
- @top_srcdir@/src/amok \
- @top_srcdir@/src/amok/Bandwidth \
- @top_srcdir@/src/amok/PeerManagement \
@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/masterslave/masterslave_console.c \
@top_srcdir@/examples/msg/migration \
@top_srcdir@/examples/msg/suspend \
@top_srcdir@/examples/msg/properties \
# the \include command).
EXAMPLE_PATH = ./ \
- @top_srcdir@/doc/gtut-files \
@top_srcdir@/src/surf/ \
@top_srcdir@/src/xbt/ \
@top_srcdir@/examples \
# 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
# 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 = footer.html
+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
# 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
# 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.
# 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
# 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
# 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.
# 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 =
+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 = 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
