Add Doxygen @file documentation to each source and header file

[ngircd-alex.git] / src / ngircd / conn-func.c

diff --git a/src/ngircd/conn-func.c b/src/ngircd/conn-func.c
index 196325eea1aa82ee6083e04d7a94a5866c22e3ad..a50f0daadded8806ad0a6be459da4762fde6bf0e 100644 (file)
--- a/src/ngircd/conn-func.c
+++ b/src/ngircd/conn-func.c
@@ -7,8 +7,6 @@
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  * Please read the file COPYING, README and AUTHORS for more information.
- *
- * Connection management: Global functions
  */
 
 
@@ -16,6 +14,11 @@
 
 #include "portab.h"
 
+/**
+ * @file
+ * Connection management: Global functions
+ */
+
 #include "imp.h"
 #include <assert.h>
 #include <string.h>
@@ -273,6 +276,16 @@ Conn_RecvBytes( CONN_ID Idx )
        return My_Connections[Idx].bytes_in;
 } /* Conn_RecvBytes */
 
+/**
+ * Return the remote IP address of this connection as string.
+ */
+GLOBAL const char *
+Conn_IPA(CONN_ID Idx)
+{
+       assert (Idx > NONE);
+       return ng_ipaddr_tostr(&My_Connections[Idx].addr);
+}
+
 
 GLOBAL void
 Conn_ResetWCounter( void )