X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/281079684f8ffe560f5793746b7270b05f8b8807..0b2a65968a229ce7facc852daf165f5cbae8a725:/doc/Doxyfile.in diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 255096d9af..003bf807e7 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -34,13 +34,13 @@ PROJECT_NAME = SimGrid # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = @release_version@ # Using the PROJECT_BRIEF tag one can provide an optional one line description # 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 = +PROJECT_BRIEF = "Scalable 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 @@ -284,7 +284,7 @@ SUBGROUPING = YES # @ingroup) instead of on a separate page (for HTML and Man pages) or # section (for LaTeX and RTF). -INLINE_GROUPED_CLASSES = NO +#INLINE_GROUPED_CLASSES = NO # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # is documented as struct, union, or enum with the name of the typedef. So @@ -551,7 +551,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_FILE = DoxygenLayoutSimgrid.xml #--------------------------------------------------------------------------- # configuration options related to warning and progress messages @@ -615,10 +615,13 @@ WARN_LOGFILE = INPUT = index.doc \ FAQ.doc \ - contrib.doc \ - publis.doc \ - people.doc \ - history.doc \ + install.doc \ + bindings.doc \ + options.doc \ + tracing.doc \ + platform.doc \ + use.doc \ + pls.doc \ ./index-API.doc \ modules.doc \ module-xbt.doc \ @@ -627,6 +630,7 @@ INPUT = index.doc \ module-amok.doc \ module-sd.doc \ module-surf.doc \ + module-trace.doc \ gtut-main.doc \ gtut-introduction.doc \ gtut-tour.doc \ @@ -650,25 +654,61 @@ INPUT = index.doc \ gtut-tour-16-exchangecb.doc \ gtut-howto.doc \ gtut-howto-design.doc \ + @top_srcdir@/doc/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/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/DataDesc \ @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/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 \ + @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 \ # 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 @@ -923,7 +963,7 @@ HTML_STYLESHEET = # files. In the HTML_STYLESHEET file, use the file name only. Also note that # the files will be copied as-is; there are no commands or markers available. -HTML_EXTRA_FILES = +#HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. # Doxygen will adjust the colors in the stylesheet and background images @@ -1223,7 +1263,7 @@ SERVER_BASED_SEARCH = NO # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. -GENERATE_LATEX = NO +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 @@ -1249,7 +1289,7 @@ MAKEINDEX_CMD_NAME = makeindex # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. -COMPACT_LATEX = NO +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 @@ -1260,7 +1300,7 @@ 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 = +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 @@ -1274,20 +1314,20 @@ LATEX_HEADER = # 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 = +#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 = NO +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 = NO +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 @@ -1512,7 +1552,10 @@ INCLUDE_FILE_PATTERNS = PREDEFINED = DOXYGEN \ DOXYGEN_SKIP_IT \ - XBT_PUBLIC= + XBT_PUBLIC= \ + XBT_INLINE= \ + HAVE_TRACING \ + MSG_USE_DEPRECATED # 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. @@ -1606,7 +1649,7 @@ HIDE_UNDOC_RELATIONS = YES # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) -HAVE_DOT = NO +HAVE_DOT = YES # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is # allowed to run in parallel. When set to 0 (the default) doxygen will @@ -1688,7 +1731,7 @@ INCLUDED_BY_GRAPH = YES # the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. -CALL_GRAPH = NO +CALL_GRAPH = YES # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller dependency graph for every global function @@ -1696,7 +1739,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 = NO +CALLER_GRAPH = YES # 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.