From: Martin Quinson Date: Thu, 18 Feb 2016 22:20:38 +0000 (+0100) Subject: further documentation improvements X-Git-Tag: v3_13~791 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/22f21f4922e994443053b7008a455ea3eef3f961 further documentation improvements --- diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index b034485653..28cca26008 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -683,7 +683,9 @@ INPUT = doxygen/index.doc \ @top_srcdir@/src/xbt/ \ @top_srcdir@/src/surf/ \ @top_srcdir@/src/surf/plugins/ \ + @top_srcdir@/src/s4u/ \ @top_srcdir@/src/msg/ \ + @top_srcdir@/src/smpi/ \ @top_srcdir@/src/simdag \ @top_srcdir@/src/simix \ @bindir@/src diff --git a/doc/Layout.xml b/doc/Layout.xml index d2983b64ed..585a480d76 100644 --- a/doc/Layout.xml +++ b/doc/Layout.xml @@ -1,21 +1,19 @@ - + + - - - - + - - - + + + diff --git a/doc/doxygen/deployment.doc b/doc/doxygen/deployment.doc index 1439a603eb..107b44b3ca 100644 --- a/doc/doxygen/deployment.doc +++ b/doc/doxygen/deployment.doc @@ -1,4 +1,4 @@ -/*! \page deployment Step 3: Deploy the simulation +/*! \page deployment Deploy the simulation \section dep_over Overview diff --git a/doc/doxygen/getting_started.doc b/doc/doxygen/getting_started.doc index 2a4dac169a..878f901d0a 100644 --- a/doc/doxygen/getting_started.doc +++ b/doc/doxygen/getting_started.doc @@ -1,9 +1,9 @@ -/*! @page getting_started Getting started with SimGrid! +/*! @page getting_started Getting started with SimGrid \tableofcontents -Welcome to SimGrid's documentation! %As you may know, SimGrid is (actively -developed) research software and contains many features. This documentation is +Welcome to SimGrid's documentation! %As you may know, SimGrid is an actively +developed research software and contains many features. This documentation is \c "work in progress" (and we need the community's help to improve this documentation! If you're ready to step up and help us, see Section \ref contributing "Contributing"), but many features are already well described. @@ -29,30 +29,31 @@ own needs. This page gives you a brief overview of available resources. | ----------------- | ------------------------------------------------- | | \ref tutorial | Introduces the user to basic features of SimGrid. | | \ref install | Explains how SimGrid can be installed; this covers Windows as well as Linux; plus, it shows how to install from a package or how to install from source. | -| [Tutorials](http://simgrid.gforge.inria.fr/tutorials.html) | These tutorials cover most of the basics and might be valuable for what you want to do, especially the [SimGrid User 101](http://simgrid.gforge.inria.fr/tutorials/simgrid-use-101.pdf). | +| [Online Tutorials](http://simgrid.gforge.inria.fr/tutorials.html) | These tutorials cover most of the basics and might be valuable for what you want to do, especially the [SimGrid User 101](http://simgrid.gforge.inria.fr/tutorials/simgrid-use-101.pdf). | | \ref MSG_examples | This document explains several tests that we wrote for MSG; these tests are working simulations and you may learn something from looking at them. | In order to actually use SimGrid, three steps are necessary: -\li \ref platform -\li \ref options -\li \ref deployment +\li Step 1: \ref platform +\li Step 2: \ref options +\li Step 3: \ref deployment \section gs_experienced_users Documentation for experienced users | Document name | Description | | ----------------- | ------------------------------------------------- | | \ref tracing | Shows how the behavior of a program can be written to a file so that it can be analyzed. | -| \ref bindings | SimGrid supports many different bindings for languages such as Lua, Ruby, Java, ... You can run your simulations with those! | -| \ref pls | Although SimGrid is not a packet level simulator, it does have bindings to two such simulators. | +| \ref bindings | You can write your application in Java, if you prefer. | +| \ref pls | You can use the NS3 simulation models instead of our own. | | \ref inside | If you want to contribute or obtain a deeper understanding of SimGrid, this is the right location. | \section gs_examples Examples shipped with SimGrid -SimGrid ships with many examples. You can find them in the folder -\c examples/. Especially when you're looking for examples on how to -use a specific XML-tag, this will prove valuable, as you can easily -search through all the files with tools like \c grep. +SimGrid ships with many examples, detailed in Section \ref +MSG_examples. You can find them in the folder \c examples/. Especially +when you're looking for examples on how to use a specific XML-tag, +this will prove valuable, as you can easily search through all the +files with tools like \c grep. Here is the output of a quick search for examples for \ref pf_trace "trace_connect": @@ -65,7 +66,4 @@ Here is the output of a quick search for examples for \ref pf_trace "trace_conne ./platforms/two_hosts_platform_with_availability_included.xml:26: \endverbatim -\note - There's also a Section on \ref MSG_examples "examples for MSG". - */ diff --git a/doc/doxygen/options.doc b/doc/doxygen/options.doc index a690ad3957..4488c39acf 100644 --- a/doc/doxygen/options.doc +++ b/doc/doxygen/options.doc @@ -1,4 +1,4 @@ -/*! \page options Step 2: Configure SimGrid +/*! \page options Configure SimGrid A number of options can be given at runtime to change the default SimGrid behavior. For a complete list of all configuration options diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc index a7b1754fe5..f7f7becc2e 100644 --- a/doc/doxygen/platform.doc +++ b/doc/doxygen/platform.doc @@ -1,4 +1,4 @@ -/*! \page platform Step 1: %Model the underlying platform +/*! \page platform %Model the underlying platform @tableofcontents diff --git a/src/surf/cpu_ti.cpp b/src/surf/cpu_ti.cpp index 93c115c984..ae2984e3ee 100644 --- a/src/surf/cpu_ti.cpp +++ b/src/surf/cpu_ti.cpp @@ -128,10 +128,8 @@ double CpuTiTgmr::integrate(double a, double b) /** * \brief Auxiliary function to compute the integral between a and b. * It simply computes the integrals at point a and b and returns the difference between them. - * \param trace Trace structure - * \param a Initial point + * \param a Initial point * \param b Final point - * \return Integral */ double CpuTiTrace::integrateSimple(double a, double b) { @@ -140,9 +138,7 @@ double CpuTiTrace::integrateSimple(double a, double b) /** * \brief Auxiliary function to compute the integral at point a. - * \param trace Trace structure * \param a point - * \return Integral */ double CpuTiTrace::integrateSimplePoint(double a) {