From: Christian Heinrich <franz-christian.heinrich@inria.fr>
Date: Fri, 11 Sep 2015 11:00:47 +0000 (+0200)
Subject: [Doc] Started cleanup of examples.doc
X-Git-Tag: v3_12~220^2~5
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/b6a1ef3676ff494c537d21a9c1b2a4ec8170defd

[Doc] Started cleanup of examples.doc
---

diff --git a/doc/doxygen/examples.doc b/doc/doxygen/examples.doc
index 8c22cba76e..533c10f863 100644
--- a/doc/doxygen/examples.doc
+++ b/doc/doxygen/examples.doc
@@ -239,23 +239,6 @@ The following listing can be found in \c examples/msg/masterslave/deployment_mas
 
 \include platforms/small_platform.xml
 
-\section using_smpi Using SMPI
-You should check our online <a href="http://simgrid.gforge.inria.fr/tutorials.html"> tutorial section</a> that contains a dedicated tutorial. 
-
-\section using_MC Using Model Checking
-You should check our online <a href="http://simgrid.gforge.inria.fr/tutorials.html"> tutorial section</a> that contains a dedicated tutorial. 
-
-\section using_trace Using Trace
-Check out the \ref tracing section.
-
-You should check our online <a href="http://simgrid.gforge.inria.fr/tutorials.html"> tutorial section</a> that contains a dedicated tutorial. 
-
-\section using_simdag Using SimDag
-You should check our online <a href="http://simgrid.gforge.inria.fr/tutorials.html"> tutorial section</a> that contains a dedicated tutorial. 
-
-\section using_simix Using SIMIX
-You should check our online <a href="http://simgrid.gforge.inria.fr/tutorials.html"> tutorial section</a> that contains a dedicated tutorial. 
-
 */
 
 
diff --git a/doc/doxygen/index.doc b/doc/doxygen/index.doc
index eaf2ff6ffd..e15a322779 100644
--- a/doc/doxygen/index.doc
+++ b/doc/doxygen/index.doc
@@ -11,8 +11,7 @@
 @endhtmlonly
 
 - @subpage introduction
-- @subpage use
-  - @ref help
+- @subpage understanding
 - @subpage platform
 - @subpage options
 - @subpage deployment
diff --git a/doc/doxygen/inside_extending.doc b/doc/doxygen/inside_extending.doc
index bb37b1d7e1..a88c6b543b 100644
--- a/doc/doxygen/inside_extending.doc
+++ b/doc/doxygen/inside_extending.doc
@@ -4,23 +4,27 @@
 \tableofcontents
 
 \section simgrid_dev_guide_model How to add a new model in surf?
-The figure below show the architecture of the SURF layer. This layer is composed
-of different kind of models representing the differents systems we want to
-modelize (i.e.cpu, network, storage, workstation, virtual machine).
+The figure below shows the architecture of the SURF layer. This layer is composed
+of different kinds of models representing the different systems we want to
+model (i.e., cpu, network, storage, workstation, virtual machine).
 
 A model in simgrid is composed of three classes: Model, Resource and Action
-(surf_interface.hpp).
+(\ref SURF_interface "surf_interface.hpp").
 
 \image html surf++.png
 \image latex surf++.pdf "surf++" width=\textwidth
 
 Actually there are five kind of models: CpuModel, NetworkModel, WorkstationModel,
 WorkstationVMModel and StorageModel. For each kind of model, there is an
-interface (e.g.: cpu_interface.hpp) and some implementations (e.g.: cpu_cas01.hpp,
+interface (e.g.: \ref SURF_cpu_interface "cpu_interface.hpp") and some implementations (e.g.: cpu_cas01.hpp,
 cpu_ti.hpp).
 
-init function:
-void surf_cpu_model_init_Cas01()
+The CPU model Cas01, for instance, is initialized by the function
+    void surf_cpu_model_init_Cas01()
+
+The different network models that are offered by simgrid are stored in the array
+that is defined as follows:
+
 s_surf_model_description_t surf_network_model_description[] = {
 
 \subsection simgrid_dev_guide_model_implem How to add a new model implementation in surf?
diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc
index 3b88012532..365daca78c 100644
--- a/doc/doxygen/platform.doc
+++ b/doc/doxygen/platform.doc
@@ -715,8 +715,8 @@ The storage facilities implemented in SimGrid help to model (and account for)
 storage devices, such as tapes, hard-drives, CD or DVD devices etc. 
 A typical situation is depicted in the figure below:
 
-\image html ./images/storage_sample_scenario.png
-\image latex ./images/storage_sample_scenario.png "storage_sample_scenario" width=\textwidth
+\image html ./webcruft/storage_sample_scenario.png
+\image latex ./webcruft/storage_sample_scenario.png "storage_sample_scenario" width=\textwidth
 
 In this figure, two hosts called Bob and Alice are interconnected via a network
 and each host is physically attached to a disk; it is not only possible for each host to
diff --git a/tools/cmake/DefinePackages.cmake b/tools/cmake/DefinePackages.cmake
index e5a6f89ac5..a3af7a0204 100644
--- a/tools/cmake/DefinePackages.cmake
+++ b/tools/cmake/DefinePackages.cmake
@@ -890,7 +890,7 @@ set(DOC_SOURCES
   doc/doxygen/pls.doc
   doc/doxygen/stylesheet.css
   doc/doxygen/tracing.doc
-  doc/doxygen/use.doc
+  doc/doxygen/examples.doc
 
   doc/manpage/smpicc.1
   doc/manpage/smpicxx.1