Doxyfy ircd_reply.h and ircd_reply.c.

git-svn-id: file:///home/klmitch/undernet-ircu/undernet-ircu-svn/ircu2/trunk@1224 c9e4aea6-c8fd-4c43-8297-357d70d61c8c

diff --git a/include/ircd_reply.h b/include/ircd_reply.h
index 9df7d96a2a755de1b0412f0b8eb6678ececc0c52..7627eacf6f7229811c98fbab6ec64e22adf8b09b 100644 (file)
--- a/include/ircd_reply.h
+++ b/include/ircd_reply.h
@@ -16,8 +16,10 @@
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id$
+ */
+/** @file
+ * @brief Interfaces for sending common replies to users.
+ * @version $Id$
  */
 #ifndef INCLUDED_ircd_reply_h
 #define INCLUDED_ircd_reply_h
@@ -26,10 +28,9 @@ struct Client;
 
 extern int protocol_violation(struct Client* cptr, const char* pattern, ...);
 extern int need_more_params(struct Client* cptr, const char* cmd);
-extern int send_error_to_client(struct Client* cptr, int error, ...);
 extern int send_reply(struct Client* to, int reply, ...);
 
-#define SND_EXPLICIT   0x40000000      /* first arg is a pattern to use */
+#define SND_EXPLICIT   0x40000000      /**< first arg is a pattern to use */
 
 #endif /* INCLUDED_ircd_reply_h */
 

diff --git a/ircd/ircd_reply.c b/ircd/ircd_reply.c
index f6662d0cd3b10e6c1b29c2269b37f051fa63b340..440d84ab4b95856de36dd31dc9d2b12d79b34d84 100644 (file)
--- a/ircd/ircd_reply.c
+++ b/ircd/ircd_reply.c
@@ -19,8 +19,10 @@
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id$
+ */
+/** @file
+ * @brief Implementation of functions to send common replies to users.
+ * @version $Id$
  */
 #include "config.h"
 
@@ -38,10 +40,12 @@
 #include <assert.h>
 #include <string.h>
 
-/* Report a protocol violation warning to anyone listening.  This can be
- * easily used to cleanup the last couple of parts of the code up.
+/** Report a protocol violation warning to anyone listening.  This can
+ * be easily used to clean up the last couple of parts of the code.
+ * @param[in] cptr Client that violated the protocol.
+ * @param[in] pattern Description of how the protocol was violated.
+ * @return Zero.
  */
- 
 int protocol_violation(struct Client* cptr, const char* pattern, ...)
 {
   struct VarData vd;
@@ -59,12 +63,22 @@ int protocol_violation(struct Client* cptr, const char* pattern, ...)
   return 0;
 }
 
+/** Inform a client that they need to provide more parameters.
+ * @param[in] cptr Taciturn client.
+ * @param[in] cmd Command name.
+ * @return Zero.
+ */
 int need_more_params(struct Client* cptr, const char* cmd)
 {
   send_reply(cptr, ERR_NEEDMOREPARAMS, cmd);
   return 0;
 }
 
+/** Send a generic reply to a user.
+ * @param[in] to Client that wants a reply.
+ * @param[in] reply Numeric of message to send.
+ * @return Zero.
+ */
 int send_reply(struct Client *to, int reply, ...)
 {
   struct VarData vd;