X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3b53885f888f2539a533797e76a3f3ff84cdfe0c..6dea47f9199885aed7d9eb3bdc45efcce1e0d39b:/doc/Doxyfile.in diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 505dc70ca9..97172ccde7 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -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 = @top_srcdir@ +STRIP_FROM_PATH = @CMAKE_HOME_DIRECTORY@ # 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 @@ -154,7 +154,7 @@ SHORT_NAMES = NO # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style @@ -210,7 +210,7 @@ TCL_SUBST = # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. -OPTIMIZE_OUTPUT_FOR_C = YES +OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for @@ -342,7 +342,7 @@ LOOKUP_CACHE_SIZE = 0 # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES -EXTRACT_ALL = NO +EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. @@ -385,7 +385,7 @@ EXTRACT_ANON_NSPACES = NO # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. -HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. @@ -399,7 +399,7 @@ HIDE_UNDOC_CLASSES = YES # If set to NO (the default) these declarations will be included in the # documentation. -HIDE_FRIEND_COMPOUNDS = NO +HIDE_FRIEND_COMPOUNDS = YES # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. @@ -616,7 +616,7 @@ WARN_IF_DOC_ERROR = YES # wrong or incomplete parameter documentation, but not about the absence of # documentation. -WARN_NO_PARAMDOC = YES +WARN_NO_PARAMDOC = NO # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text @@ -644,79 +644,61 @@ WARN_LOGFILE = INPUT = doxygen/index.doc \ doxygen/getting_started.doc \ - doxygen/introduction.doc \ doxygen/install.doc \ - doxygen/use.doc \ - doxygen/platform.doc \ + doxygen/application.doc \ + doxygen/bindings.doc \ + doxygen/platform.doc \ + doxygen/models.doc \ + doxygen/ns3.doc \ + doxygen/platform_lua.doc \ + doxygen/scenario.doc \ doxygen/deployment.doc \ doxygen/options.doc \ - doxygen/help.doc \ - doxygen/advanced.doc \ - doxygen/pls.doc \ - doxygen/bindings.doc \ - doxygen/internals.doc \ + doxygen/outcomes.doc \ + doxygen/outcomes_logs.doc \ + doxygen/outcomes_vizu.doc \ + doxygen/outcomes_MC.doc \ + doxygen/tutorial.doc \ + doxygen/examples.doc \ + doxygen/uhood.doc \ + doxygen/inside.doc \ doxygen/inside_doxygen.doc \ doxygen/inside_extending.doc \ doxygen/inside_cmake.doc \ - doxygen/inside_ci.doc \ + doxygen/inside_tests.doc \ doxygen/inside_release.doc \ - doxygen/contributing.doc \ - doxygen/tracing.doc \ + doxygen/community.doc \ + doxygen/community_contact.doc \ + doxygen/community_contributing.doc \ + doxygen/community_extend.doc \ + doxygen/community_giveback.doc \ doxygen/FAQ.doc \ - doxygen/modules.doc \ + doxygen/module-msg.doc \ + doxygen/module-sd.doc \ + doxygen/module-index.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/xbt \ - @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) -################################################### - -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/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 + @CMAKE_HOME_DIRECTORY@/doc/doxygen/logcategories.doc \ + @CMAKE_HOME_DIRECTORY@/src/instr/ \ + @CMAKE_HOME_DIRECTORY@/include/ \ + @CMAKE_HOME_DIRECTORY@/include/xbt \ + @CMAKE_HOME_DIRECTORY@/include/simgrid \ + @CMAKE_HOME_DIRECTORY@/include/simgrid/s4u \ + @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 \ + @CMAKE_HOME_DIRECTORY@/examples/msg/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 @@ -777,9 +759,10 @@ EXCLUDE_SYMBOLS = # the \include command). EXAMPLE_PATH = ./ \ - @top_srcdir@/src/surf/ \ - @top_srcdir@/src/xbt/ \ - @top_srcdir@/examples + @CMAKE_HOME_DIRECTORY@/src/surf/ \ + @CMAKE_HOME_DIRECTORY@/src/xbt/ \ + @CMAKE_HOME_DIRECTORY@/examples \ + @CMAKE_HOME_DIRECTORY@/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 @@ -799,8 +782,8 @@ EXAMPLE_RECURSIVE = YES # directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = @top_srcdir@/doc \ - @top_srcdir@/doc/webcruft +IMAGE_PATH = @CMAKE_HOME_DIRECTORY@/doc \ + @CMAKE_HOME_DIRECTORY@/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 @@ -1247,7 +1230,7 @@ USE_MATHJAX = YES # However, it is strongly recommended to install a local # copy of MathJax from http://www.mathjax.org before deployment. -MATHJAX_RELPATH = http://www.mathjax.org/mathjax +MATHJAX_RELPATH = https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension # names that should be enabled during MathJax rendering. @@ -1459,15 +1442,13 @@ 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" \ +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 \ XBT_INLINE= \ - MSG_USE_DEPRECATED + XBT_PRIVATE= # 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.