1
0
mirror of https://github.com/osmarks/ngircd.git synced 2024-12-15 11:20:26 +00:00

Fix typos/errors/... in file comments

Found by Xcode/Clang code analyzer. No functional changes.
This commit is contained in:
Alexander Barton 2018-10-30 01:48:31 +01:00
parent a38eea8987
commit e8e04b4c8f
8 changed files with 20 additions and 22 deletions

View File

@ -1,6 +1,6 @@
/* /*
* ngIRCd -- The Next Generation IRC Daemon * ngIRCd -- The Next Generation IRC Daemon
* Copyright (c)2001-2014 Alexander Barton (alex@barton.de) and Contributors. * Copyright (c)2001-2018 Alexander Barton (alex@barton.de) and Contributors.
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
@ -711,7 +711,6 @@ Conf_NickIsService(int ConfServer, const char *Nick)
/** /**
* Check if the given nickname is blocked for "normal client" use. * Check if the given nickname is blocked for "normal client" use.
* *
* @param ConfServer The server index or NONE to check all configured servers.
* @param Nick The nickname to check. * @param Nick The nickname to check.
* @returns true if the given nickname belongs to an "IRC service". * @returns true if the given nickname belongs to an "IRC service".
*/ */
@ -845,7 +844,7 @@ no_listenports(void)
* *
* This function is used to read the MOTD and help text file, for example. * This function is used to read the MOTD and help text file, for example.
* *
* @param filename Name of the file to read. * @param Filename Name of the file to read.
* @return true, when the file has been read in. * @return true, when the file has been read in.
*/ */
static bool static bool
@ -887,9 +886,9 @@ Read_TextFile(const char *Filename, const char *Name, array *Destination)
* Please note that this function uses exit(1) on fatal errors and therefore * Please note that this function uses exit(1) on fatal errors and therefore
* can result in ngIRCd terminating! * can result in ngIRCd terminating!
* *
* @param ngircd_starting Flag indicating if ngIRCd is starting or not. * @param IsStarting Flag indicating if ngIRCd is starting or not.
* @returns true when the configuration file has been read * @returns true when the configuration file has been read
* successfully; false otherwise. * successfully; false otherwise.
*/ */
static bool static bool
Read_Config(bool TestOnly, bool IsStarting) Read_Config(bool TestOnly, bool IsStarting)

View File

@ -1,6 +1,6 @@
/* /*
* ngIRCd -- The Next Generation IRC Daemon * ngIRCd -- The Next Generation IRC Daemon
* Copyright (c)2001-2014 Alexander Barton (alex@barton.de) and Contributors. * Copyright (c)2001-2018 Alexander Barton (alex@barton.de) and Contributors.
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
@ -85,7 +85,7 @@ Conn_LastPing( CONN_ID Idx )
* is read. This function only increases the penalty, it is not possible to * is read. This function only increases the penalty, it is not possible to
* decrease the penalty time. * decrease the penalty time.
* *
* @param Idex Connection index. * @param Idx Connection index.
* @param Seconds Seconds to add. * @param Seconds Seconds to add.
* @see Conn_ResetPenalty * @see Conn_ResetPenalty
*/ */

View File

@ -2402,7 +2402,7 @@ Conn_GetFromProc(int fd)
* @param Reason The reason, see THROTTLE_xxx constants. * @param Reason The reason, see THROTTLE_xxx constants.
* @param Idx The connection index. * @param Idx The connection index.
* @param Client The client of this connection. * @param Client The client of this connection.
* @param Seconds The time to delay this connection. * @param Value The time to delay this connection.
*/ */
static void static void
Throttle_Connection(const CONN_ID Idx, CLIENT *Client, const int Reason, Throttle_Connection(const CONN_ID Idx, CLIENT *Client, const int Reason,

View File

@ -1,6 +1,6 @@
/* /*
* ngIRCd -- The Next Generation IRC Daemon * ngIRCd -- The Next Generation IRC Daemon
* Copyright (c)2001-2014 Alexander Barton (alex@barton.de) and Contributors. * Copyright (c)2001-2018 Alexander Barton (alex@barton.de) and Contributors.
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
@ -380,11 +380,10 @@ va_dcl
* Send a message to all the servers in the network using a specific prefix * Send a message to all the servers in the network using a specific prefix
* and matching a "client flag" using a callback function. * and matching a "client flag" using a callback function.
* *
* @param Client The sending client, excluded while forwarding the message. * @param ExceptOf The sending client, excluded while forwarding the message.
* @param Prefix The prefix to use. * @param Prefix The prefix to use.
* @param Flag Client flag that must be set on the target. * @param Flag Client flag that must be set on the target.
* @param callback Callback function. * @param callback Callback function.
* @param Format Format string.
*/ */
GLOBAL void GLOBAL void
IRC_WriteStrServersPrefixFlag_CB(CLIENT *ExceptOf, CLIENT *Prefix, char Flag, IRC_WriteStrServersPrefixFlag_CB(CLIENT *ExceptOf, CLIENT *Prefix, char Flag,

View File

@ -415,7 +415,7 @@ IRC_KillClient(CLIENT *Client, CLIENT *From, const char *Nick, const char *Reaso
* Send help for a given topic to the client. * Send help for a given topic to the client.
* *
* @param Client The client requesting help. * @param Client The client requesting help.
* @param Topoc The help topic requested. * @param Topic The help topic requested.
* @return CONNECTED or DISCONNECTED. * @return CONNECTED or DISCONNECTED.
*/ */
static bool static bool

View File

@ -1,6 +1,6 @@
/* /*
* ngIRCd -- The Next Generation IRC Daemon * ngIRCd -- The Next Generation IRC Daemon
* Copyright (c)2001-2014 Alexander Barton (alex@barton.de) and Contributors. * Copyright (c)2001-2018 Alexander Barton (alex@barton.de) and Contributors.
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
@ -39,7 +39,7 @@ struct list_elem {
/** /**
* Get IRC mask stored in list element. * Get IRC mask stored in list element.
* *
* @param list_elem List element. * @param e List element.
* @return Pointer to IRC mask * @return Pointer to IRC mask
*/ */
GLOBAL const char * GLOBAL const char *
@ -52,7 +52,7 @@ Lists_GetMask(const struct list_elem *e)
/** /**
* Get optional "reason" text stored in list element. * Get optional "reason" text stored in list element.
* *
* @param list_elem List element. * @param e List element.
* @return Pointer to "reason" text or empty string (""). * @return Pointer to "reason" text or empty string ("").
*/ */
GLOBAL const char * GLOBAL const char *
@ -65,7 +65,7 @@ Lists_GetReason(const struct list_elem *e)
/** /**
* Get "validity" value stored in list element. * Get "validity" value stored in list element.
* *
* @param list_elem List element. * @param e List element.
* @return Validity: 0=unlimited, >0 until this time stamp. * @return Validity: 0=unlimited, >0 until this time stamp.
*/ */
GLOBAL time_t GLOBAL time_t
@ -78,7 +78,7 @@ Lists_GetValidity(const struct list_elem *e)
/** /**
* Get "onlyonce" value stored in list element. * Get "onlyonce" value stored in list element.
* *
* @param list_elem List element. * @param e List element.
* @return True if the element was stored for single use, false otherwise. * @return True if the element was stored for single use, false otherwise.
*/ */
GLOBAL bool GLOBAL bool

View File

@ -1,6 +1,6 @@
/* /*
* ngIRCd -- The Next Generation IRC Daemon * ngIRCd -- The Next Generation IRC Daemon
* Copyright (c)2001-2014 Alexander Barton (alex@barton.de) and Contributors. * Copyright (c)2001-2018 Alexander Barton (alex@barton.de) and Contributors.
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
@ -77,7 +77,7 @@ MatchCaseInsensitive(const char *Pattern, const char *String)
/** /**
* Match string with pattern case-insensitive. * Match string with pattern case-insensitive.
* *
* @param pattern Pattern to match with * @param Pattern Pattern to match with
* @param String Input string, at most COMMAND_LEN-1 characters long * @param String Input string, at most COMMAND_LEN-1 characters long
* @param Separator Character separating the individual patterns in the list * @param Separator Character separating the individual patterns in the list
* @return true if pattern matches * @return true if pattern matches

View File

@ -1,6 +1,6 @@
/* /*
* ngIRCd -- The Next Generation IRC Daemon * ngIRCd -- The Next Generation IRC Daemon
* Copyright (c)2001-2014 Alexander Barton (alex@barton.de) and Contributors. * Copyright (c)2001-2018 Alexander Barton (alex@barton.de) and Contributors.
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
@ -58,7 +58,7 @@ Op_NoPrivileges(CLIENT * Client, REQUEST * Req)
* Check that the originator of a request is an IRC operator and allowed * Check that the originator of a request is an IRC operator and allowed
* to administer this server. * to administer this server.
* *
* @param CLient Client from which the command has been received. * @param Client Client from which the command has been received.
* @param Req Request structure. * @param Req Request structure.
* @return CLIENT structure of the client that initiated the command or * @return CLIENT structure of the client that initiated the command or
* NULL if client is not allowed to execute operator commands. * NULL if client is not allowed to execute operator commands.