Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Set up documentation for simix
[simgrid.git] / doc / Doxyfile.in
index a99a99b..003bf80 100644 (file)
@@ -40,7 +40,7 @@ PROJECT_NUMBER         = @release_version@
 # 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          = "<i>Scalable simulation of distributed systems</i>"
+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
@@ -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
@@ -619,7 +619,8 @@ INPUT                  = index.doc \
                          bindings.doc \
                          options.doc \
                          tracing.doc \
-                         use.doc \
+                         platform.doc \
+                        use.doc \
                          pls.doc \
                          ./index-API.doc \
                          modules.doc \
@@ -629,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 \
@@ -652,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
@@ -1251,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
@@ -1262,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
@@ -1515,7 +1553,9 @@ INCLUDE_FILE_PATTERNS  =
 PREDEFINED             = DOXYGEN \
                          DOXYGEN_SKIP_IT \
                          XBT_PUBLIC= \
-                         XBT_INLINE=
+                         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.
@@ -1609,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
@@ -1691,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
@@ -1699,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.