X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/e2ec31cd19284f7cc75b071f8a6006f05a468faa..1bec72ac5423ee42eed942337b2a8a0a5c82c530:/doc/Doxyfile.in diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index f6d0b20457..12601ad858 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -116,7 +116,7 @@ ALWAYS_DETAILED_SEC = NO # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. -INLINE_INHERITED_MEMB = YES +INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set @@ -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 = @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 @@ -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 @@ -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 @@ -322,22 +322,6 @@ INLINE_SIMPLE_STRUCTS = NO TYPEDEF_HIDES_STRUCT = NO -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penalty. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. - -SYMBOL_CACHE_SIZE = 0 - # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given # their name and scope. Since this can be an expensive process and often the @@ -358,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. @@ -401,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. @@ -415,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. @@ -632,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 @@ -660,9 +644,10 @@ WARN_LOGFILE = INPUT = doxygen/index.doc \ doxygen/getting_started.doc \ - doxygen/introduction.doc \ + doxygen/getting_started_index.doc \ + doxygen/tutorial.doc \ doxygen/install.doc \ - doxygen/use.doc \ + doxygen/examples.doc \ doxygen/platform.doc \ doxygen/deployment.doc \ doxygen/options.doc \ @@ -670,11 +655,11 @@ INPUT = doxygen/index.doc \ doxygen/advanced.doc \ doxygen/pls.doc \ doxygen/bindings.doc \ - doxygen/internals.doc \ + doxygen/inside.doc \ doxygen/inside_doxygen.doc \ doxygen/inside_extending.doc \ doxygen/inside_cmake.doc \ - doxygen/inside_autotests.doc \ + doxygen/inside_tests.doc \ doxygen/inside_release.doc \ doxygen/contributing.doc \ doxygen/tracing.doc \ @@ -685,54 +670,58 @@ INPUT = doxygen/index.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/ \ - @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 + @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@/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 += @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 \ - @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 +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/icomms/peer2.c \ + @CMAKE_HOME_DIRECTORY@/examples/msg/icomms/peer3.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/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/pmm \ + @CMAKE_HOME_DIRECTORY@/examples/msg/chord\ + @CMAKE_HOME_DIRECTORY@/examples/msg/task-priority/task-priority.c \ + @CMAKE_HOME_DIRECTORY@/examples/msg/properties \ + @CMAKE_HOME_DIRECTORY@/examples/msg/parallel_task # 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 @@ -764,7 +753,7 @@ 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 @@ -793,10 +782,10 @@ EXCLUDE_SYMBOLS = # the \include command). EXAMPLE_PATH = ./ \ - @top_srcdir@/src/surf/ \ - @top_srcdir@/src/xbt/ \ - @top_srcdir@/examples \ - @top_srcdir@/testsuite + @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 @@ -816,8 +805,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 @@ -1021,7 +1010,7 @@ HTML_COLORSTYLE_GAMMA = 80 # page will contain the date and time when the page was generated. Setting # this to NO can help when comparing the output of multiple runs. -HTML_TIMESTAMP = YES +HTML_TIMESTAMP = NO # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the @@ -1252,7 +1241,7 @@ FORMULA_TRANSPARENT = YES # output. When enabled you may also need to install MathJax separately and # configure the path to it using the MATHJAX_RELPATH option. -USE_MATHJAX = NO +USE_MATHJAX = YES # When MathJax is enabled you need to specify the location relative to the # HTML output directory using the MATHJAX_RELPATH option. The destination @@ -1264,7 +1253,7 @@ USE_MATHJAX = NO # 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. @@ -1298,97 +1287,7 @@ SERVER_BASED_SEARCH = NO # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. -GENERATE_LATEX = YES - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `latex' will be used as the default path. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the -# default command name. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_LATEX = YES - -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, letter, legal and -# executive. If left blank a4wide will be used. - -PAPER_TYPE = a4wide - -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. - -EXTRA_PACKAGES = pdfpages - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! - -LATEX_HEADER = - -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for -# the generated latex document. The footer should contain everything after -# the last chapter. If it is left blank doxygen will generate a -# standard footer. Notice: only use this tag if you know what you are doing! - -LATEX_FOOTER = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. - -PDF_HYPERLINKS = YES - -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. - -USE_PDFLATEX = YES - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. - -LATEX_BATCHMODE = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -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. -# Note that which sources are shown also depends on other settings -# such as SOURCE_BROWSER. - -LATEX_SOURCE_CODE = NO - -# The LATEX_BIB_STYLE tag can be used to specify the style to use for the -# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See -# http://en.wikipedia.org/wiki/BibTeX for more info. - -LATEX_BIB_STYLE = plain +GENERATE_LATEX = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output @@ -1470,31 +1369,6 @@ MAN_LINKS = NO GENERATE_XML = NO -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- @@ -1593,10 +1467,12 @@ INCLUDE_FILE_PATTERNS = PREDEFINED = DOXYGEN \ DOXYGEN_SKIP_IT \ - XBT_PUBLIC= \ - XBT_INLINE= \ - HAVE_TRACING \ - MSG_USE_DEPRECATED + 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= # 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.