summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorPeter Powell <petpow@saberuk.com>2013-06-21 03:52:56 +0100
committerPeter Powell <petpow@saberuk.com>2013-06-21 03:52:56 +0100
commit146d72fddbcc443e402b3aadcf1eb8195b9d4ab5 (patch)
treeb6eb362d5d5538d7a71ff77f26ce37155388117c /include
parentb81cfe31711acbb9ced2639e0a2f2c2df3c7a293 (diff)
Fix Doxygen comments.
Diffstat (limited to 'include')
-rw-r--r--include/channels.h2
-rw-r--r--include/command_parse.h1
-rw-r--r--include/inspircd.h8
-rw-r--r--include/listmode.h5
-rw-r--r--include/modules.h4
-rw-r--r--include/timer.h1
-rw-r--r--include/users.h8
7 files changed, 15 insertions, 14 deletions
diff --git a/include/channels.h b/include/channels.h
index 566eb5cfb..b4977eef1 100644
--- a/include/channels.h
+++ b/include/channels.h
@@ -218,7 +218,7 @@ class CoreExport Channel : public Extensible, public InviteBase
* @param user The user to join to the channel
* @param privs Priviliges (prefix mode letters) to give to this user, may be NULL
* @param bursting True if this join is the result of a netburst (passed to modules in the OnUserJoin hook)
- * @param created True if this channel was just created by a local user (passed to modules in the OnUserJoin hook)
+ * @param created_by_local True if this channel was just created by a local user (passed to modules in the OnUserJoin hook)
*/
void ForceJoin(User* user, const std::string* privs = NULL, bool bursting = false, bool created_by_local = false);
diff --git a/include/command_parse.h b/include/command_parse.h
index b39bf31c0..f9ea1df7f 100644
--- a/include/command_parse.h
+++ b/include/command_parse.h
@@ -123,6 +123,7 @@ class CoreExport CommandParser
* @param item The input string
* @param dest The output string. The translation result will be appended to this string
* @param custom_translator Used to translate the parameter if the translation type is TR_CUSTOM, if NULL, TR_CUSTOM will act like TR_TEXT
+ * @param paramnumber The index of the parameter we are translating.
*/
static void TranslateSingleParam(TranslateType to, const std::string& item, std::string& dest, Command* custom_translator = NULL, unsigned int paramnumber = 0);
diff --git a/include/inspircd.h b/include/inspircd.h
index a25466647..a634eb2c8 100644
--- a/include/inspircd.h
+++ b/include/inspircd.h
@@ -478,7 +478,7 @@ class CoreExport InspIRCd
caller1<bool, const std::string&> IsChannel;
/** Return true if str looks like a server ID
- * @param string to check against
+ * @param sid string to check against
*/
static bool IsSID(const std::string& sid);
@@ -509,9 +509,9 @@ class CoreExport InspIRCd
*/
static void QuickExit(int status);
- /** Printf-wrapper.
- * @param How you want it formatted
- * @param ...
+ /** Formats the input string with the specified arguments.
+ * @param formatString The string to format
+ * @param ... A variable number of format arguments.
* @return The formatted string
*/
static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
diff --git a/include/listmode.h b/include/listmode.h
index 149f41578..e27071eac 100644
--- a/include/listmode.h
+++ b/include/listmode.h
@@ -106,7 +106,8 @@ class CoreExport ListModeBase : public ModeHandler
public:
/** Constructor.
- * @param Instance The creator of this class
+ * @param Creator The creator of this class
+ * @param Name Mode name
* @param modechar Mode character
* @param eolstr End of list string
* @param lnum List numeric
@@ -175,7 +176,7 @@ class CoreExport ListModeBase : public ModeHandler
/** Validate parameters.
* Overridden by implementing module.
- * @param source Source user adding the parameter
+ * @param user Source user adding the parameter
* @param channel Channel the parameter is being added to
* @param parameter The actual parameter being added
* @return true if the parameter is valid
diff --git a/include/modules.h b/include/modules.h
index a5f99ee86..1a88a0389 100644
--- a/include/modules.h
+++ b/include/modules.h
@@ -843,7 +843,7 @@ class CoreExport Module : public classbase, public usecountbase
/** Called when a 005 numeric is about to be output.
* The module should modify the 005 numeric if needed to indicate its features.
- * @param output The 005 map to be modified if neccessary.
+ * @param tokens The 005 map to be modified if neccessary.
*/
virtual void On005Numeric(std::map<std::string, std::string>& tokens);
@@ -1202,7 +1202,7 @@ class CoreExport FileReader : public classbase
FileReader() : totalSize(0) { }
/** Initializes a new file reader and reads the specified file.
- * @param file The file to read into memory.
+ * @param filename The file to read into memory.
*/
FileReader(const std::string& filename);
diff --git a/include/timer.h b/include/timer.h
index 6f1834178..2887e2b52 100644
--- a/include/timer.h
+++ b/include/timer.h
@@ -49,7 +49,6 @@ class CoreExport Timer
public:
/** Default constructor, initializes the triggering time
- * @param mod The module that created this timer
* @param secs_from_now The number of seconds from now to trigger the timer
* @param now The time now
* @param repeating Repeat this timer every secs_from_now seconds if set to true
diff --git a/include/users.h b/include/users.h
index 941e57667..218ec4ae0 100644
--- a/include/users.h
+++ b/include/users.h
@@ -598,8 +598,8 @@ class CoreExport User : public Extensible
void WriteCommonQuit(const std::string &normal_text, const std::string &oper_text);
/** Dump text to a user target, splitting it appropriately to fit
- * @param LinePrefix text to prefix each complete line with
- * @param TextStream the text to send to the user
+ * @param linePrefix text to prefix each complete line with
+ * @param textStream the text to send to the user
*/
void SendText(const std::string& linePrefix, std::stringstream& textStream);
@@ -818,7 +818,7 @@ class CoreExport LocalUser : public User, public InviteBase
InviteList& GetInviteList();
/** Returns true if a user is invited to a channel.
- * @param channel A channel to look up
+ * @param chan A channel to look up
* @return True if the user is invited to the given channel
*/
bool IsInvited(Channel* chan) { return (Invitation::Find(chan, this) != NULL); }
@@ -826,7 +826,7 @@ class CoreExport LocalUser : public User, public InviteBase
/** Removes a channel from a users invite list.
* This member function is called on successfully joining an invite only channel
* to which the user has previously been invited, to clear the invitation.
- * @param channel The channel to remove the invite to
+ * @param chan The channel to remove the invite to
* @return True if the user was invited to the channel and the invite was erased, false if the user wasn't invited
*/
bool RemoveInvite(Channel* chan);