Add Doxygen @file documentation to each source and header file

[ngircd-alex.git] / src / ngircd / client.c

diff --git a/src/ngircd/client.c b/src/ngircd/client.c
index dd4113e48e83c25641d90c3695cf9ff47942baa4..7a6b275da5918ea0030a12f4aa97804d980cd6ee 100644 (file)
--- a/src/ngircd/client.c
+++ b/src/ngircd/client.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.
- *
- * Client management.
  */
 
 
@@ -17,6 +15,11 @@
 
 #include "portab.h"
 
+/**
+ * @file
+ * Client management.
+ */
+
 #include "imp.h"
 #include <assert.h>
 #include <unistd.h>
@@ -93,7 +96,7 @@ Client_Init( void )
        This_Server->hops = 0;
 
        gethostname( This_Server->host, CLIENT_HOST_LEN );
-       if (!Conf_NoDNS) {
+       if (Conf_DNS) {
                h = gethostbyname( This_Server->host );
                if (h) strlcpy(This_Server->host, h->h_name, sizeof(This_Server->host));
        }
@@ -363,7 +366,8 @@ Client_SetUser( CLIENT *Client, const char *User, bool Idented )
  * @param User User name to set.
  */
 GLOBAL void
-Client_SetOrigUser(CLIENT UNUSED *Client, const char UNUSED *User) {
+Client_SetOrigUser(CLIENT UNUSED *Client, const char UNUSED *User)
+{
        assert(Client != NULL);
        assert(User != NULL);
 
@@ -552,17 +556,19 @@ Client_Search( const char *Nick )
 } /* Client_Search */
 
 
+/**
+ * Get client structure ("introducer") identfied by a server token.
+ * @return CLIENT structure or NULL if none could be found.
+ */
 GLOBAL CLIENT *
 Client_GetFromToken( CLIENT *Client, int Token )
 {
-       /* Client-Struktur, die den entsprechenden Introducer (=Client)
-        * und das gegebene Token hat, liefern. Wird keine gefunden,
-        * so wird NULL geliefert. */
-
        CLIENT *c;
 
        assert( Client != NULL );
-       assert( Token > 0 );
+
+       if (!Token)
+               return NULL;
 
        c = My_Clients;
        while (c) {
@@ -1193,7 +1199,7 @@ Client_RegisterWhowas( CLIENT *Client )
                 sizeof( My_Whowas[slot].id ));
        strlcpy( My_Whowas[slot].user, Client_User( Client ),
                 sizeof( My_Whowas[slot].user ));
-       strlcpy( My_Whowas[slot].host, Client_Hostname( Client ),
+       strlcpy( My_Whowas[slot].host, Client_HostnameCloaked( Client ),
                 sizeof( My_Whowas[slot].host ));
        strlcpy( My_Whowas[slot].info, Client_Info( Client ),
                 sizeof( My_Whowas[slot].info ));
@@ -1274,4 +1280,26 @@ Destroy_UserOrService(CLIENT *Client, const char *Txt, const char *FwdMsg, bool
 } /* Destroy_UserOrService */
 
 
+#ifdef DEBUG
+
+GLOBAL void
+Client_DebugDump(void)
+{
+       CLIENT *c;
+
+       Log(LOG_DEBUG, "Client status:");
+       c = My_Clients;
+       while (c) {
+               Log(LOG_DEBUG,
+                   " - %s: type=%d, host=%s, user=%s, conn=%d, start=%ld, flags=%s",
+                   Client_ID(c), Client_Type(c), Client_Hostname(c),
+                   Client_User(c), Client_Conn(c), Client_StartTime(c),
+                   Client_Flags(c));
+               c = (CLIENT *)c->next;
+       }
+} /* Client_DumpClients */
+
+#endif
+
+
 /* -eof- */