tiny doc improvement

diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst
index f0b7d30..c4dbd41 100644 (file)
--- a/docs/source/app_s4u.rst
+++ b/docs/source/app_s4u.rst
@@ -394,6 +394,8 @@ s4u::Actor
 
 .. doxygentypedef:: ActorPtr
 
 
 .. doxygentypedef:: ActorPtr
 

+.. doxygentypedef:: aid_t
+

 .. doxygenclass:: simgrid::s4u::Actor
    :members:
    :protected-members:
 .. doxygenclass:: simgrid::s4u::Actor
    :members:
    :protected-members:

diff --git a/include/simgrid/forward.h b/include/simgrid/forward.h
index 4da6084..2ebb20b 100644 (file)
--- a/include/simgrid/forward.h
+++ b/include/simgrid/forward.h
@@ -232,6 +232,7 @@ typedef unsigned long long sg_size_t;
  */
 typedef long long sg_offset_t;
 
  */
 typedef long long sg_offset_t;
 

+/** Actor's ID, just like the classical processes' have PID in UNIX */

 typedef long aid_t;
 
 #endif /* SIMGRID_TYPES_H */
 typedef long aid_t;
 
 #endif /* SIMGRID_TYPES_H */

diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp
index 61a78a0..757fadf 100644 (file)
--- a/include/simgrid/s4u/Actor.hpp
+++ b/include/simgrid/s4u/Actor.hpp
@@ -206,13 +206,9 @@ public:
   const char* get_cname() const;
   /** Retrieves the host on which that actor is running */
   s4u::Host* get_host();
   const char* get_cname() const;
   /** Retrieves the host on which that actor is running */
   s4u::Host* get_host();

-  /** Retrieves the PID of that actor
-   *
-   * aid_t is an alias for long */
+  /** Retrieves the actor ID of that actor */

   aid_t get_pid() const;
   aid_t get_pid() const;

-  /** Retrieves the PPID of that actor
-   *
-   * aid_t is an alias for long */
+  /** Retrieves the actor ID of that actor's creator */

   aid_t get_ppid() const;
 
   /** Suspend an actor by suspending the task on which it was waiting for the completion. */
   aid_t get_ppid() const;
 
   /** Suspend an actor by suspending the task on which it was waiting for the completion. */


@@ -485,7 +481,7 @@ XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
 
 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
 

-/** @brief Returns the actor ID of the current actor). */
+/** @brief Returns the actor ID of the current actor. */

 XBT_PUBLIC aid_t get_pid();
 
 /** @brief Returns the ancestor's actor ID of the current actor. */
 XBT_PUBLIC aid_t get_pid();
 
 /** @brief Returns the ancestor's actor ID of the current actor. */