Try to activate coverity for simgrid

[simgrid.git] / include / xbt / peer.h

diff --git a/include/xbt/peer.h b/include/xbt/peer.h
index 7c5b03d..4e402c0 100644 (file)
--- a/include/xbt/peer.h
+++ b/include/xbt/peer.h
@@ -1,6 +1,6 @@
 /* peer.h - peer (remote processes) management functions                    */
 
-/* Copyright (c) 2006, 2007, 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2006-2007, 2009-2010, 2012-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -13,10 +13,21 @@
 
 SG_BEGIN_DECL()
 
-     typedef struct {
-       char *name;
-       int port;
-     } s_xbt_peer_t, *xbt_peer_t;
+/** @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_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 */
+#endif                          /* XBT_PEER_H */