-/*
- * get_client_name
- * Return the name of the client for various tracking and
- * admin purposes. The main purpose of this function is to
- * return the "socket host" name of the client, if that
- * differs from the advertised name (other than case).
- * But, this can be used to any client structure.
- *
- * Returns:
- * "name[user@ip#.port]" if 'showip' is true;
- * "name" if 'showip' is false.
- *
- * NOTE 1:
- * Watch out the allocation of "nbuf", if either sptr->name
- * or sptr->sockhost gets changed into pointers instead of
- * directly allocated within the structure...
- *
- * NOTE 2:
- * Function return either a pointer to the structure (sptr) or
- * to internal buffer (nbuf). *NEVER* use the returned pointer
- * to modify what it points!!!
+/** Return the name of the client for various tracking and admin
+ * purposes. The main purpose of this function is to return the
+ * "socket host" name of the client, if that differs from the
+ * advertised name (other than case). But, this can be used on any
+ * client structure.
+ * @param sptr Client to operate on.
+ * @param showip If non-zero, append [username\@text-ip] to name.
+ * @return Either cli_name(\a sptr) or a static buffer.