doc: fix broken references

diff --git a/doc/doxygen/deployment.doc b/doc/doxygen/deployment.doc
index 7168ff3..8ee6d60 100644 (file)
--- a/doc/doxygen/deployment.doc
+++ b/doc/doxygen/deployment.doc
@@ -1,7 +1,5 @@
 /*! @page deployment Deploy the simulation
 
 /*! @page deployment Deploy the simulation
 

-@section dep_over Overview
-

 When you want to simulate the behavior of your code with SimGrid, you need
 to tell SimGrid exactly what code (that you wrote) is supposed to be run by which host - so you need to assign
 processes/functions to hosts. The hosts in question here are the hosts of your platform model; see Section @ref platform for details on how to set one up.
 When you want to simulate the behavior of your code with SimGrid, you need
 to tell SimGrid exactly what code (that you wrote) is supposed to be run by which host - so you need to assign
 processes/functions to hosts. The hosts in question here are the hosts of your platform model; see Section @ref platform for details on how to set one up.


@@ -34,12 +32,9 @@ attributes are mandatory; however, there are some optional attributes to the pro
 | kill_time       | no        | int (Default: -1.0)    | The simulated time when this function will end to be computed. By default, it stops only when it's done.                  |
 | on_failure      | no        | DIE\|RESTART (Default: "DIE")   | What should be done when the process fails.                  |
 
 | kill_time       | no        | int (Default: -1.0)    | The simulated time when this function will end to be computed. By default, it stops only when it's done.                  |
 | on_failure      | no        | DIE\|RESTART (Default: "DIE")   | What should be done when the process fails.                  |
 

-#### An example ####
-
-A complete example including a @ref MSG_ext_ms_application "deployment file" can be found 
-in the Section @ref msg_ex_basics "MSG basics".
+#### Examples ####

 
 

-See also files such as @c examples/msg/masterslave/deployment_masterslave.xml.
+Almost any @ref MSG_examples include a deployment file.

 
 ### The argument tag ###
 
 
 ### The argument tag ###
 


@@ -57,11 +52,4 @@ executed by this process) in the order you declare them.
 | --------------- | --------- | ---------------------- | -----------                                                                                                               |
 | value           | yes       | String                 | Contains the value for this parameter |
 
 | --------------- | --------- | ---------------------- | -----------                                                                                                               |
 | value           | yes       | String                 | Contains the value for this parameter |
 

-#### An example ####
-
-A complete example including a @ref MSG_ext_ms_application "deployment file" can be found 
-in the Section @ref msg_ex_basics "MSG basics".
-
-See also files such as @c examples/msg/masterslave/deployment_masterslave.xml.
-

 */
 */

diff --git a/doc/doxygen/install.doc b/doc/doxygen/install.doc
index dd3d673..60b5213 100644 (file)
--- a/doc/doxygen/install.doc
+++ b/doc/doxygen/install.doc
@@ -179,7 +179,7 @@ In addition to the classical cmake configuration variables, SimGrid accepts seve
       will **hinder simulation speed** even when the model-checker is
       not activated at run time.
 
       will **hinder simulation speed** even when the model-checker is
       not activated at run time.
 

-  @li <b>enable_ns3</b> (ON/OFF) if you want to use ns-3. See section @ref pls_simgrid_configuration_ns3.
+  @li <b>enable_ns3</b> (ON/OFF) if you want to use ns-3. See section @ref pls_ns3.

 
   @li <b>enable_smpi</b> (ON/OFF) to run MPI code on top of SimGrid.
 
 
   @li <b>enable_smpi</b> (ON/OFF) to run MPI code on top of SimGrid.
 

diff --git a/src/surf/AsClusterFatTree.hpp b/src/surf/AsClusterFatTree.hpp
index 130066b..e4cb4c0 100644 (file)
--- a/src/surf/AsClusterFatTree.hpp
+++ b/src/surf/AsClusterFatTree.hpp
@@ -11,16 +11,9 @@
 namespace simgrid {
 namespace surf {
 
 namespace simgrid {
 namespace surf {
 

-/** \file surf_routing_cluster_fat_tree.cpp
- *  The class AsClusterFatTree describes PGFT, as introduced by Eitan Zahavi
- * in "D-Mod-K Routing Providing Non-Blocking Traffic for Shift Permutations
- * on Real Life Fat Trees" (2010). RLFT are PGFT with some restrictions to 
- * address real world constraints, which are not currently enforced. 
- */
-

 class XBT_PRIVATE FatTreeLink;
 
 class XBT_PRIVATE FatTreeLink;
 

-/** \brief A node in a fat tree.
+/** \brief A node in a fat tree (@ref AsClusterFatTree).

  * A FatTreeNode can either be a switch or a processing node. Switches are
  * identified by a negative ID. This class is closely related to fat
  */
  * A FatTreeNode can either be a switch or a processing node. Switches are
  * identified by a negative ID. This class is closely related to fat
  */


@@ -62,7 +55,7 @@ public:
 
 
 
 
 
 

-/** \brief Link in a fat tree.
+/** \brief Link in a fat tree (@ref AsClusterFatTree).

  *
  * Represents a single, duplex link in a fat tree. This is necessary to have a tree.
  * It is equivalent to a physical link.
  *
  * Represents a single, duplex link in a fat tree. This is necessary to have a tree.
  * It is equivalent to a physical link.


@@ -80,15 +73,17 @@ public:
   FatTreeNode *downNode;
 };
 
   FatTreeNode *downNode;
 };
 

-

 /** 
  * \class AsClusterFatTree
  *
  * \brief Fat tree representation and routing.
  *
 /** 
  * \class AsClusterFatTree
  *
  * \brief Fat tree representation and routing.
  *

- * Generate fat trees according to the topology asked for. Almost everything
- * is based on the work of Eitan Zahavi in "D-Mod-K Routing Providing
- * Non-Blocking Traffic for Shift Permutations on Real Life Fat Trees" (2010).
+ * Generate fat trees according to the topology asked for, according to:
+ * Eitan Zahavi, D-Mod-K Routing Providing Non-Blocking Traffic for Shift
+ * Permutations on Real Life Fat Trees (2010).
+ *
+ * RLFT are PGFT with some restrictions to address real world constraints,
+ * which are not currently enforced.

  *
  * The exact topology is described in the mandatory topo_parameters
  * field, and follow the "h ; m_h, ..., m_1 ; w_h, ..., w_1 ; p_h, ..., p_1" format.
  *
  * The exact topology is described in the mandatory topo_parameters
  * field, and follow the "h ; m_h, ..., m_1 ; w_h, ..., w_1 ; p_h, ..., p_1" format.

diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp
index 7ed69d0..8c4eae4 100644 (file)
--- a/src/surf/network_interface.hpp
+++ b/src/surf/network_interface.hpp
@@ -131,7 +131,7 @@ namespace simgrid {
      ************/
     /** @ingroup SURF_network_interface
      * @brief SURF network link interface class
      ************/
     /** @ingroup SURF_network_interface
      * @brief SURF network link interface class

-     * @details A Link represents the link between two [hosts](\ref simgrid::surf::Host)
+     * @details A Link represents the link between two [hosts](\ref simgrid::surf::HostImpl)

      */
     class Link :
         public simgrid::surf::Resource,
      */
     class Link :
         public simgrid::surf::Resource,


@@ -222,7 +222,7 @@ namespace simgrid {
      **********/
     /** @ingroup SURF_network_interface
      * @brief SURF network action interface class
      **********/
     /** @ingroup SURF_network_interface
      * @brief SURF network action interface class

-     * @details A NetworkAction represents a communication between two [hosts](\ref Host)
+     * @details A NetworkAction represents a communication between two [hosts](\ref HostImpl)

      */
     class NetworkAction : public simgrid::surf::Action {
     public:
      */
     class NetworkAction : public simgrid::surf::Action {
     public: