ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/trunk/modules/m_admin.c
(Generate patch)

Comparing ircd-hybrid-7.2/modules/m_admin.c (file contents):
Revision 589 by michael, Mon May 8 18:40:00 2006 UTC vs.
Revision 1007 by michael, Tue Sep 1 15:25:26 2009 UTC

# Line 1 | Line 1
1   /*
2   *  ircd-hybrid: an advanced Internet Relay Chat Daemon(ircd).
3 *  m_admin.c: Sends administrative information to a user.
3   *
4   *  Copyright (C) 2002 by the past and present ircd coders, and others.
5   *
# Line 18 | Line 17
17   *  along with this program; if not, write to the Free Software
18   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
19   *  USA
20 < *
21 < *  $Id$
20 > */
21 >
22 > /*! \file m_admin.c
23 > * \brief Includes required functions for processing the ADMIN command.
24 > * \version $Id$
25   */
26  
27   #include "stdinc.h"
# Line 72 | Line 74 | _moddeinit(void)
74   }
75   #endif
76  
77 < /*
78 < * mr_admin - ADMIN command handler
79 < *      parv[0] = sender prefix  
80 < *      parv[1] = servername  
77 > /*! \brief ADMIN command handler (called by unregistered,
78 > *         locally connected clients)
79 > *
80 > * \param client_p Pointer to allocated Client struct with physical connection
81 > *                 to this server, i.e. with an open socket connected.
82 > * \param source_p Pointer to allocated Client struct from which the message
83 > *                 originally comes from.  This can be a local or remote client.
84 > * \param parc     Integer holding the number of supplied arguments.
85 > * \param parv     Argument vector where parv[0] .. parv[parc-1] are non-NULL
86 > *                 pointers.
87 > * \note Valid arguments for this command are:
88 > *      - parv[0] = sender prefix
89   */
90   static void
91   mr_admin(struct Client *client_p, struct Client *source_p,
# Line 101 | Line 111 | mr_admin(struct Client *client_p, struct
111   #endif
112   }
113  
114 < /*
115 < * m_admin - ADMIN command handler
116 < *      parv[0] = sender prefix
117 < *      parv[1] = servername
114 > /*! \brief NICK command handler (called by already registered,
115 > *         locally connected clients)
116 > *
117 > * \param client_p Pointer to allocated Client struct with physical connection
118 > *                 to this server, i.e. with an open socket connected.
119 > * \param source_p Pointer to allocated Client struct from which the message
120 > *                 originally comes from.  This can be a local or remote client.
121 > * \param parc     Integer holding the number of supplied arguments.
122 > * \param parv     Argument vector where parv[0] .. parv[parc-1] are non-NULL
123 > *                 pointers.
124 > * \note Valid arguments for this command are:
125 > *      - parv[0] = sender prefix
126 > *      - parv[1] = nickname/servername
127   */
128   static void
129   m_admin(struct Client *client_p, struct Client *source_p,
# Line 133 | Line 152 | m_admin(struct Client *client_p, struct
152   #endif
153   }
154  
155 < /*
156 < * ms_admin - ADMIN command handler, used for OPERS as well
157 < *      parv[0] = sender prefix
158 < *      parv[1] = servername
155 > /*! \brief ADMIN command handler (called by operators and
156 > *         remotely connected clients)
157 > *
158 > * \param client_p Pointer to allocated Client struct with physical connection
159 > *                 to this server, i.e. with an open socket connected.
160 > * \param source_p Pointer to allocated Client struct from which the message
161 > *                 originally comes from.  This can be a local or remote client.
162 > * \param parc     Integer holding the number of supplied arguments.
163 > * \param parv     Argument vector where parv[0] .. parv[parc-1] are non-NULL
164 > *                 pointers.
165 > * \note Valid arguments for this command are:
166 > *      - parv[0] = sender prefix
167 > *      - parv[1] = nickname/servername
168   */
169   static void
170   ms_admin(struct Client *client_p, struct Client *source_p,
# Line 154 | Line 182 | ms_admin(struct Client *client_p, struct
182   #endif
183   }
184  
185 < /* do_admin()
185 > /*! \brief Sends administrative information about this server.
186   *
187 < * inputs       - pointer to client to report to
160 < * output       - none
161 < * side effects - admin info is sent to client given
187 > * \param source_p Pointer to client to report to
188   */
189   static void
190   do_admin(struct Client *source_p)

Diff Legend

Removed lines
+ Added lines
< Changed lines (old)
> Changed lines (new)