Reorder and complete doxygen input directories.

[simgrid.git] / doc / Doxyfile.in

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 75a24f4..afe08e7 100644 (file)
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -131,7 +131,8 @@ FULL_PATH_NAMES        = YES
 # If left blank the directory from which doxygen is run is used as the
 # path to strip.
 
 # If left blank the directory from which doxygen is run is used as the
 # path to strip.
 

-STRIP_FROM_PATH        = @CMAKE_HOME_DIRECTORY@
+STRIP_FROM_PATH        = @CMAKE_HOME_DIRECTORY@ \
+                         @CMAKE_BINARY_DIR@

 
 # 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
 
 # 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


@@ -570,7 +571,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.
 
 # 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            = Layout.xml
+LAYOUT_FILE            = @CMAKE_HOME_DIRECTORY@/doc/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
 
 # 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


@@ -642,87 +643,85 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 

-INPUT                  = doxygen/index.doc \
-                         doxygen/getting_started.doc \
-                         doxygen/getting_started_index.doc \
-                         doxygen/tutorial.doc \
-                         doxygen/install.doc \
-                         doxygen/examples.doc \
-                           doxygen/platform.doc \
-                           doxygen/deployment.doc \
-                           doxygen/options.doc \
-                           doxygen/help.doc \
-                        doxygen/advanced.doc \
-                           doxygen/pls.doc \
-                           doxygen/bindings.doc \
-                          doxygen/inside.doc \
-                            doxygen/inside_doxygen.doc \
-                            doxygen/inside_extending.doc \
-                            doxygen/inside_cmake.doc \
-                            doxygen/inside_tests.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-smpi.doc \
-                           doxygen/module-trace.doc \
-                           index-API.doc \
-                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/logcategories.doc \
-                         @CMAKE_HOME_DIRECTORY@/src/instr/ \
+INPUT                  = @CMAKE_HOME_DIRECTORY@/doc/doxygen/index.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/getting_started.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/install.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/install_yours.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/application.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/java.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/platform.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/models.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/ns3.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/platform_lua.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/scenario.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/deployment.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/options.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/outcomes.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/outcomes_logs.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/outcomes_vizu.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/outcomes_MC.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/tuto-msg/tuto-msg.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/tutorial_smpi.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/examples.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/howtos.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/uhood.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/uhood_arch.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/uhood_switch.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/inside.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/inside_doxygen.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/inside_extending.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/inside_cmake.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/inside_tests.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/inside_release.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/community.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/FAQ.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/module-msg.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/module-sd.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/module-index.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/module-xbt.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/module-s4u.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/module-surf.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/module-simix.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/module-smpi.doc \
+                         @CMAKE_HOME_DIRECTORY@/doc/doxygen/module-trace.doc \
+                         @CMAKE_BINARY_DIR@/doc/doxygen/logcategories.doc \

                          @CMAKE_HOME_DIRECTORY@/include/ \
                          @CMAKE_HOME_DIRECTORY@/include/ \

+                         @CMAKE_HOME_DIRECTORY@/include/simgrid/ \
+                         @CMAKE_HOME_DIRECTORY@/include/simgrid/jedule/ \
+                         @CMAKE_HOME_DIRECTORY@/include/simgrid/kernel/ \
+                         @CMAKE_HOME_DIRECTORY@/include/simgrid/kernel/resource/ \
+                         @CMAKE_HOME_DIRECTORY@/include/simgrid/kernel/routing/ \
+                         @CMAKE_HOME_DIRECTORY@/include/simgrid/plugins/ \
+                         @CMAKE_HOME_DIRECTORY@/include/simgrid/s4u/ \
+                         @CMAKE_HOME_DIRECTORY@/include/simgrid/simix/ \
+                         @CMAKE_HOME_DIRECTORY@/include/simgrid/smpi/ \

                          @CMAKE_HOME_DIRECTORY@/include/xbt \
                          @CMAKE_HOME_DIRECTORY@/include/xbt \

-                         @CMAKE_HOME_DIRECTORY@/include/simgrid \
+                         @CMAKE_HOME_DIRECTORY@/src/include/simgrid/ \

                          @CMAKE_HOME_DIRECTORY@/src/include/surf \
                          @CMAKE_HOME_DIRECTORY@/src/include/surf \

-                         @CMAKE_HOME_DIRECTORY@/src/xbt/ \
-                         @CMAKE_HOME_DIRECTORY@/src/surf/ \
-                         @CMAKE_HOME_DIRECTORY@/src/surf/plugins/ \
-                         @CMAKE_HOME_DIRECTORY@/src/s4u/ \
+                         @CMAKE_HOME_DIRECTORY@/src/include/xbt \
+                         @CMAKE_HOME_DIRECTORY@/src/instr/ \
+                         @CMAKE_HOME_DIRECTORY@/src/instr/jedule/ \
+                         @CMAKE_HOME_DIRECTORY@/src/kernel/ \
+                         @CMAKE_HOME_DIRECTORY@/src/kernel/activity/ \
+                         @CMAKE_HOME_DIRECTORY@/src/kernel/context/ \
+                         @CMAKE_HOME_DIRECTORY@/src/kernel/lmm/ \
+                         @CMAKE_HOME_DIRECTORY@/src/kernel/resource/ \
+                         @CMAKE_HOME_DIRECTORY@/src/kernel/routing/ \

                          @CMAKE_HOME_DIRECTORY@/src/msg/ \
                          @CMAKE_HOME_DIRECTORY@/src/msg/ \

+                         @CMAKE_HOME_DIRECTORY@/src/plugins/ \
+                         @CMAKE_HOME_DIRECTORY@/src/plugins/file_system/ \
+                         @CMAKE_HOME_DIRECTORY@/src/plugins/vm/ \
+                         @CMAKE_HOME_DIRECTORY@/src/s4u/ \
+                         @CMAKE_HOME_DIRECTORY@/src/simdag/ \
+                         @CMAKE_HOME_DIRECTORY@/src/simgrid/ \
+                         @CMAKE_HOME_DIRECTORY@/src/simix/ \

                          @CMAKE_HOME_DIRECTORY@/src/smpi/ \
                          @CMAKE_HOME_DIRECTORY@/src/smpi/ \

-                         @CMAKE_HOME_DIRECTORY@/src/simdag \
-                         @CMAKE_HOME_DIRECTORY@/src/simix \
+                         @CMAKE_HOME_DIRECTORY@/src/surf/ \
+                         @CMAKE_HOME_DIRECTORY@/src/xbt/ \

                          @CMAKE_BINARY_DIR@/include \
                          @CMAKE_BINARY_DIR@/include \

-                         @CMAKE_BINARY_DIR@/src
-
-
-###################################################
-##  PLEASE DON'T MESS WITH THE ORDER OF EXAMPLES ## (unless you know what you are doing, of course)
-###################################################
-
-INPUT +=                 @CMAKE_HOME_DIRECTORY@/examples/msg/app-pingpong/app-pingpong.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/app-token-ring/app-token-ring.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/app-masterworker/app-masterworker.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/async-wait/async-wait.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/async-waitall/async-waitall.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/async-waitany/async-waitany.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/process-suspend/process-suspend.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/process-kill/process-kill.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/process-migration/process-migration.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/process-startkilltime/process-startkilltime.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/trace-simple/trace-simple.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/trace-platform/trace-platform.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/trace-categories/trace-categories.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/trace-masterworker/trace-masterworker.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/trace-process-migration/trace-process-migration.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/trace-user-variables/trace-user-variables.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/trace-link-user-variables/trace-link-user-variables.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/trace-link-srcdst-user-variables/trace-link-srcdst-user-variables.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/network-ns3/network-ns3.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/io-storage/io-storage.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/io-file/io-file.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/io-remote/io-remote.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/actions-comm/actions-comm.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/actions-storage/actions-storage.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/app-pmm/ \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/dht-chord \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/task-priority/task-priority.c \
-                         @CMAKE_HOME_DIRECTORY@/examples/msg/properties/properties.c
+                         @CMAKE_BINARY_DIR@/src \
+                         @CMAKE_HOME_DIRECTORY@/examples/msg/README.doc \
+                         @CMAKE_HOME_DIRECTORY@/examples/s4u/README.doc

 
 # 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
 
 # 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


@@ -746,7 +745,7 @@ FILE_PATTERNS          =
 # should be searched for input files as well. Possible values are YES and NO.
 # If left blank NO is used.
 
 # should be searched for input files as well. Possible values are YES and NO.
 # If left blank NO is used.
 

-RECURSIVE              = NO
+RECURSIVE              = YES

 
 # The EXCLUDE tag can be used to specify files and/or directories that should be
 # excluded from the INPUT source files. This way you can easily exclude a
 
 # The EXCLUDE tag can be used to specify files and/or directories that should be
 # excluded from the INPUT source files. This way you can easily exclude a


@@ -754,13 +753,13 @@ RECURSIVE              = NO
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 

-EXCLUDE                = 
+EXCLUDE                =

 
 # 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
 # from the input.
 
 
 # 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
 # from the input.
 

-EXCLUDE_SYMLINKS       = NO
+EXCLUDE_SYMLINKS       = YES

 
 # 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
 
 # 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


@@ -783,10 +782,14 @@ EXCLUDE_SYMBOLS        =
 # the \include command).
 
 EXAMPLE_PATH           = ./ \
 # the \include command).
 
 EXAMPLE_PATH           = ./ \

+                         @CMAKE_HOME_DIRECTORY@/doc/ \

                          @CMAKE_HOME_DIRECTORY@/src/surf/ \
                          @CMAKE_HOME_DIRECTORY@/src/surf/ \

+                         @CMAKE_HOME_DIRECTORY@/src/surf/xml/ \

                          @CMAKE_HOME_DIRECTORY@/src/xbt/ \
                          @CMAKE_HOME_DIRECTORY@/src/xbt/ \

+                         @CMAKE_HOME_DIRECTORY@/include \

                          @CMAKE_HOME_DIRECTORY@/examples \
                          @CMAKE_HOME_DIRECTORY@/examples \

-                         @CMAKE_HOME_DIRECTORY@/doc/example_lists
+                         @CMAKE_BINARY_DIR@/doc/example_lists \
+                         @CMAKE_HOME_DIRECTORY@/doc/tuto-msg

 
 # 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
 
 # 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


@@ -865,7 +868,7 @@ INLINE_SOURCES         = NO
 # doxygen to hide any special comment blocks from generated source code
 # fragments. Normal C and C++ comments will always remain visible.
 
 # doxygen to hide any special comment blocks from generated source code
 # fragments. Normal C and C++ comments will always remain visible.
 

-STRIP_CODE_COMMENTS    = YES
+STRIP_CODE_COMMENTS    = NO

 
 # If the REFERENCED_BY_RELATION tag is set to YES
 # then for each documented function all documented
 
 # If the REFERENCED_BY_RELATION tag is set to YES
 # then for each documented function all documented


@@ -885,7 +888,7 @@ REFERENCES_RELATION    = NO
 # link to the source code.
 # Otherwise they will link to the documentation.
 
 # link to the source code.
 # Otherwise they will link to the documentation.
 

-REFERENCES_LINK_SOURCE = YES
+REFERENCES_LINK_SOURCE = NO

 
 # If the USE_HTAGS tag is set to YES then the references to source code
 # will point to the HTML generated by the htags(1) tool instead of doxygen
 
 # If the USE_HTAGS tag is set to YES then the references to source code
 # will point to the HTML generated by the htags(1) tool instead of doxygen


@@ -956,13 +959,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!
 
 # 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            = doxygen/header.html 
+HTML_HEADER            = @CMAKE_HOME_DIRECTORY@/doc/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.
 
 
 # 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            = doxygen/footer.html
+HTML_FOOTER            = @CMAKE_HOME_DIRECTORY@/doc/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 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


@@ -971,7 +974,7 @@ HTML_FOOTER            = doxygen/footer.html
 # 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!
 
 # 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        = doxygen/stylesheet.css
+HTML_STYLESHEET        = @CMAKE_HOME_DIRECTORY@/doc/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
 
 # 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


@@ -1466,13 +1469,15 @@ INCLUDE_FILE_PATTERNS  =
 # undefined via #undef or recursively expanded use the := operator
 # instead of the = operator.
 
 # undefined via #undef or recursively expanded use the := operator
 # instead of the = operator.
 

-PREDEFINED             = 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 \
+PREDEFINED             = XBT_PUBLIC= \
+                         XBT_EXPORT_NO_IMPORT= \
+                         XBT_IMPORT_NO_EXPORT= \
+                         XBT_PUBLIC_DATA=extern \

                          XBT_INLINE= \
                          XBT_INLINE= \

-                        XBT_PRIVATE=/** @private /
+                        XBT_PRIVATE= \
+                         XBT_ATTRIB_DEPRECATED_v322(m)= \
+                         XBT_ATTRIB_DEPRECATED_v323(m)= \
+                         XBT_ATTRIB_DEPRECATED_v324(m)=

 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be expanded.
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be expanded.


@@ -1480,7 +1485,8 @@ PREDEFINED             = XBT_PUBLIC(type)="extern type" \
 # Use the PREDEFINED tag if you want to use a different macro definition that
 # overrules the definition found in the source code.
 
 # Use the PREDEFINED tag if you want to use a different macro definition that
 # overrules the definition found in the source code.
 

-EXPAND_AS_DEFINED      =
+EXPAND_AS_DEFINED      = COLL_APPLY COLL_GATHERS COLL_ALLGATHERS COLL_ALLGATHERVS COLL_ALLREDUCES COLL_ALLTOALLS \
+                         COLL_ALLTOALLVS COLL_BCASTS COLL_REDUCES COLL_REDUCE_SCATTERS COLL_SCATTERS COLL_BARRIERS

 
 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
 # doxygen's preprocessor will remove all references to function-like macros
 
 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
 # doxygen's preprocessor will remove all references to function-like macros