From: Martin Quinson <martin.quinson@loria.fr>
Date: Tue, 20 Mar 2012 15:00:49 +0000 (+0100)
Subject: document xbt_peer_t and friends
X-Git-Tag: v3_7~287
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/dbc7d3bf1b818ca3aa2dbebb4792909faa1f19ee

document xbt_peer_t and friends
---

diff --git a/doc/module-xbt.doc b/doc/module-xbt.doc
index a874b52e2a..4c0b2b1ed8 100644
--- a/doc/module-xbt.doc
+++ b/doc/module-xbt.doc
@@ -19,6 +19,7 @@
       - \ref XBT_queue
       - \ref XBT_swag
       - \ref XBT_heap
+      - \ref XBT_peer
     - \ref XBT_misc
       - \ref XBT_graph
  
diff --git a/include/xbt/peer.h b/include/xbt/peer.h
index a04d9c0b64..dbf8122081 100644
--- a/include/xbt/peer.h
+++ b/include/xbt/peer.h
@@ -13,10 +13,21 @@
 
 SG_BEGIN_DECL()
 
-typedef struct {
+/** @addtogroup XBT_peer
+ *  \brief Helper functions to manipulate remote hosts
+ *
+ *  This module simply introduces some rather trivial functions to manipulate remote host denomination (in the form hostname:port)
+ *
+ *  @{
+ */
+/** @brief Object describing a remote host (as name:port) */
+typedef struct s_xbt_peer *xbt_peer_t;
+
+/** @brief Structure describing a remote host (as name:port) */
+typedef struct s_xbt_peer {
   char *name;
   int port;
-} s_xbt_peer_t, *xbt_peer_t;
+} s_xbt_peer_t;
 
 XBT_PUBLIC(xbt_peer_t) xbt_peer_new(const char *name, int port);
 XBT_PUBLIC(xbt_peer_t) xbt_peer_from_string(const char *peerport);
@@ -24,5 +35,6 @@ XBT_PUBLIC(xbt_peer_t) xbt_peer_copy(xbt_peer_t h);
 XBT_PUBLIC(void) xbt_peer_free(xbt_peer_t peer);
 XBT_PUBLIC(void) xbt_peer_free_voidp(void *d);
 
+/** @} */
 SG_END_DECL()
 #endif                          /* XBT_PEER_H */
diff --git a/src/xbt/xbt_peer.c b/src/xbt/xbt_peer.c
index 80dae08705..919f51dd5a 100644
--- a/src/xbt/xbt_peer.c
+++ b/src/xbt/xbt_peer.c
@@ -21,6 +21,7 @@ xbt_peer_t xbt_peer_new(const char *name, int port)
   return res;
 }
 
+/** \brief copy constructor */
 xbt_peer_t xbt_peer_copy(xbt_peer_t h)
 {
   return xbt_peer_new(h->name, h->port);