Modern C++: prefer type aliasing with using to C-style typedef

[simgrid.git] / include / simgrid / host.h

diff --git a/include/simgrid/host.h b/include/simgrid/host.h
index d30750eda9eda43b53fbb3fc27f7a6e2142b32c4..843c0fcfb41ee7bd6b24c0cfa51027d8e52b3b9b 100644 (file)
--- a/include/simgrid/host.h
+++ b/include/simgrid/host.h
@@ -11,16 +11,15 @@
 #include <simgrid/forward.h>
 
 SG_BEGIN_DECL
-/** @brief Host datatype.
+/** Returns an array of all existing hosts (use sg_host_count() to know the array size).
  *
- *   A <em>location</em> (or <em>host</em>) is any possible place where an actor may run. Thus it is represented as a
- *   <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running actors to
- *   communicate with remote ones, and some <em>private data</em> that can be only accessed by local actors.
+ * @remark The host order in this array is generally different from the
+ * creation/declaration order in the XML platform (we use a hash table
+ * internally).
  */
-
 XBT_PUBLIC sg_host_t* sg_host_list();
 
-/** @brief Return the current number of hosts. */
+/** Returns the amount of hosts existing in the platform. */
 XBT_PUBLIC size_t sg_host_count();
 
 /**
@@ -33,17 +32,13 @@ XBT_PUBLIC xbt_dynar_t sg_hosts_as_dynar();
 XBT_PUBLIC size_t sg_host_extension_create(void (*deleter)(void*));
 XBT_PUBLIC void* sg_host_extension_get(const_sg_host_t host, size_t rank);
 
-/** @brief Finds a sg_host_t using its name.
- *
- * This is a name directory service
- * @param name the name of an host.
- * @return the corresponding host
- */
+/** Finds an host from its name */
 XBT_PUBLIC sg_host_t sg_host_by_name(const char* name);
 
-/** @brief Return the name of the #sg_host_t. */
+/** @brief Return the name of the sg_host_t. */
 XBT_PUBLIC const char* sg_host_get_name(const_sg_host_t host);
 
+#ifndef DOXYGEN
 // ========== User Data ==============
 /** @brief Return the user data of a #sg_host_t.
  *
@@ -59,6 +54,7 @@ XBT_PUBLIC void sg_host_data_set(sg_host_t host, void* userdata);
 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set()") XBT_PUBLIC
     void sg_host_user_set(sg_host_t host, void* userdata);
 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set(h, NULL)") XBT_PUBLIC void sg_host_user_destroy(sg_host_t host);
+#endif
 
 // ========= storage related functions ============
 /** @brief Return the list of mount point names on an host.
@@ -92,7 +88,11 @@ XBT_PUBLIC sg_host_t sg_host_self();
 
 XBT_PUBLIC const char* sg_host_self_get_name();
 
-/** @brief Return the total count of pstates defined for a host. See also @ref plugin_energy.
+/** @brief Return the total count of pstates defined for a host.
+ *
+ * @beginrst
+ * See also :ref:`plugin_host_energy`.
+ * @endrst
  *
  * @param  host host to test
  */