X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/365e954b81e6b41967504bde0d64844402e8c87c..a73d204e173f35c0abb92b26e061929066b8b283:/doc/Doxyfile.in diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 383a2bc081..ee539201ba 100644 --- 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. -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 @@ -160,7 +161,7 @@ JAVADOC_AUTOBRIEF = YES # interpret the first line (until the first dot) of a Qt-style # comment as the brief description. If set to NO, the comments # will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# an explicit @brief command for a brief description.) QT_AUTOBRIEF = NO @@ -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. -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 @@ -642,84 +643,52 @@ WARN_LOGFILE = # 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/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/xbt \ - @CMAKE_HOME_DIRECTORY@/include/simgrid \ - @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/msg/ \ - @CMAKE_HOME_DIRECTORY@/src/smpi/ \ - @CMAKE_HOME_DIRECTORY@/src/simdag \ - @CMAKE_HOME_DIRECTORY@/src/simix \ - @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-masterworker/app-masterworker.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/process-migration/process-migration.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/process-suspend/process-suspend.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/properties \ - @CMAKE_HOME_DIRECTORY@/examples/msg/parallel_task \ - @CMAKE_HOME_DIRECTORY@/examples/msg/priority \ - @CMAKE_HOME_DIRECTORY@/examples/msg/icomms/peer.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/icomms/peer2.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/icomms/peer3.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/simple.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/ms.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/categories.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/procmig.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/trace_platform.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/user_variables.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/link_user_variables.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/tracing/link_srcdst_user_variables.c \ - @CMAKE_HOME_DIRECTORY@/examples/msg/ns3 \ - @CMAKE_HOME_DIRECTORY@/examples/msg/io \ - @CMAKE_HOME_DIRECTORY@/examples/msg/gpu \ - @CMAKE_HOME_DIRECTORY@/examples/msg/actions \ - @CMAKE_HOME_DIRECTORY@/examples/msg/token_ring \ - @CMAKE_HOME_DIRECTORY@/examples/msg/pmm \ - @CMAKE_HOME_DIRECTORY@/examples/msg/chord + @CMAKE_HOME_DIRECTORY@/src/plugins/ \ + @CMAKE_HOME_DIRECTORY@/examples/deprecated/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 @@ -743,7 +712,7 @@ FILE_PATTERNS = # 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 @@ -751,13 +720,13 @@ RECURSIVE = NO # 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. -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 @@ -765,7 +734,18 @@ EXCLUDE_SYMLINKS = NO # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = */include/simgrid/forward.h +EXCLUDE_PATTERNS += */include/smpi/* + +EXCLUDE_PATTERNS += @CMAKE_HOME_DIRECTORY@/src/surf/xml/simgrid_dtd.* +EXCLUDE_PATTERNS += @CMAKE_HOME_DIRECTORY@/src/simdag/dax_dtd.* +EXCLUDE_PATTERNS += @CMAKE_HOME_DIRECTORY@/src/xbt/automaton/parserPromela.* +EXCLUDE_PATTERNS += @CMAKE_HOME_DIRECTORY@/src/bindings/java/*.cpp @CMAKE_HOME_DIRECTORY@/src/bindings/java/*.h +EXCLUDE_PATTERNS += @CMAKE_HOME_DIRECTORY@/src/simix/popping_accessors.hpp \ + @CMAKE_HOME_DIRECTORY@/src/simix/popping_bodies.cpp \ + @CMAKE_HOME_DIRECTORY@/src/simix/popping_enum.h \ + @CMAKE_HOME_DIRECTORY@/src/simix/popping_generated.cpp + # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -773,17 +753,23 @@ EXCLUDE_PATTERNS = # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = s_xbt_dict_cursor s_xbt_dictelm xbt_dynar_s +EXCLUDE_SYMBOLS += xbt_edge xbt_graph xbt_node +EXCLUDE_SYMBOLS += e_xbt_parmap_mode_t +EXCLUDE_SYMBOLS += MPI_* # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = ./ \ + @CMAKE_HOME_DIRECTORY@/doc/ \ @CMAKE_HOME_DIRECTORY@/src/surf/ \ + @CMAKE_HOME_DIRECTORY@/src/surf/xml/ \ @CMAKE_HOME_DIRECTORY@/src/xbt/ \ + @CMAKE_HOME_DIRECTORY@/include \ @CMAKE_HOME_DIRECTORY@/examples \ - @CMAKE_HOME_DIRECTORY@/doc/example_lists + @CMAKE_BINARY_DIR@/doc/example_lists # 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 @@ -862,7 +848,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. -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 @@ -882,7 +868,7 @@ REFERENCES_RELATION = NO # 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 @@ -942,25 +928,6 @@ HTML_OUTPUT = html HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. Note that when using a custom header you are responsible -# for the proper inclusion of any scripts and style sheets that doxygen -# needs, which is dependent on the configuration options used. -# It is advised to generate a default header using "doxygen -w html -# header.html footer.html stylesheet.css YourConfigFile" and then modify -# that header. Note that the header is subject to change so you typically -# 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 - -# 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 - # 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 # fine-tune the look of the HTML output. If the tag is left blank doxygen @@ -968,7 +935,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! -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 @@ -1365,7 +1332,7 @@ MAN_LINKS = NO # generate an XML file that captures the structure of # the code including all documentation. -GENERATE_XML = NO +GENERATE_XML = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output @@ -1463,14 +1430,20 @@ INCLUDE_FILE_PATTERNS = # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = DOXYGEN \ - DOXYGEN_SKIP_IT \ - 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= +PREDEFINED = __cplusplus \ + DOXYGEN \ + XBT_PUBLIC= \ + XBT_EXPORT_NO_IMPORT= \ + XBT_IMPORT_NO_EXPORT= \ + XBT_PUBLIC_DATA=extern \ + XBT_PUBLIC= \ + XBT_INLINE= \ + XBT_ALWAYS_INLINE= \ + XBT_PRIVATE= \ + XBT_ATTRIB_NORETURN= \ + XBT_ATTRIB_UNUSED= \ + XBT_ATTRIB_DEPRECATED_v327(m)= \ + XBT_ATTRIB_DEPRECATED_v328(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. @@ -1478,7 +1451,9 @@ PREDEFINED = DOXYGEN \ # 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 \ + MPI_CALL # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all references to function-like macros @@ -1538,7 +1513,7 @@ PERL_PATH = /usr/bin/perl # this option also works with HAVE_DOT disabled, but it is recommended to # install and use dot, since it yields more powerful graphs. -CLASS_DIAGRAMS = YES +CLASS_DIAGRAMS = NO # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see @@ -1657,7 +1632,7 @@ CALL_GRAPH = NO # the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. -CALLER_GRAPH = YES +CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will generate a graphical hierarchy of all classes instead of a textual one. @@ -1677,7 +1652,7 @@ DIRECTORY_GRAPH = YES # HTML_FILE_EXTENSION to xhtml in order to make the SVG files # visible in IE 9+ (other browsers do not have this requirement). -DOT_IMAGE_FORMAT = png +DOT_IMAGE_FORMAT = svg # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # enable generation of interactive SVG images that allow zooming and panning.