Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
also include the 101 presentation into the latex documentation
[simgrid.git] / doc / Doxyfile.in
index 255096d..45710e8 100644 (file)
@@ -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
@@ -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,18 +654,20 @@ 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@/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 \
@@ -670,6 +676,38 @@ INPUT                  = index.doc \
                          @top_srcdir@/src/amok/PeerManagement \
                          @top_srcdir@/src/simdag
 
+###################################################
+##  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
 # also the default input encoding. Doxygen uses libiconv (or the iconv built
@@ -923,7 +961,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 +1261,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 +1287,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 +1298,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 +1312,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 +1550,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.