diff options
author | InspIRCd Robot <noreply@inspircd.org> | 2020-04-21 06:34:17 +0000 |
---|---|---|
committer | Matt Schatz <genius3000@g3k.solutions> | 2020-04-21 00:52:12 -0600 |
commit | 4f9abe96a4301a740d4a5fd7932550d88d60a3fc (patch) | |
tree | eafd249fbf0c3ad4c631146446d5d953508e88b4 /include/modules.h | |
parent | 43d0efaa2195c445ae7cc130d235781506758a9d (diff) |
Fixes by misspell-fixer
Diffstat (limited to 'include/modules.h')
-rw-r--r-- | include/modules.h | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/include/modules.h b/include/modules.h index 82684cac8..2b578e58c 100644 --- a/include/modules.h +++ b/include/modules.h @@ -185,7 +185,7 @@ class CoreExport Version /** Simple module version */ Version(const std::string &desc, int flags = VF_NONE); - /** Complex version information, including linking compatability data */ + /** Complex version information, including linking compatibility data */ Version(const std::string &desc, int flags, const std::string& linkdata); }; @@ -227,7 +227,7 @@ enum Implementation /** Base class for all InspIRCd modules * This class is the base class for InspIRCd modules. All modules must inherit from this class, * its methods will be called when irc server events occur. class inherited from module must be - * instantiated by the ModuleFactory class (see relevent section) for the module to be initialised. + * instantiated by the ModuleFactory class (see relevant section) for the module to be initialised. */ class CoreExport Module : public classbase, public usecountbase { @@ -446,7 +446,7 @@ class CoreExport Module : public classbase, public usecountbase /** Called after a user opers locally. * This is identical to Module::OnOper(), except it is called after OnOper so that other modules - * can be gauranteed to already have processed the oper-up, for example m_spanningtree has sent + * can be guaranteed to already have processed the oper-up, for example m_spanningtree has sent * out the OPERTYPE, etc. * @param user The user who is opering up * @param opername The name of the oper that the user is opering up to. Only valid locally. Empty string otherwise. @@ -472,7 +472,7 @@ class CoreExport Module : public classbase, public usecountbase virtual ModResult OnUserPreInvite(User* source,User* dest,Channel* channel, time_t timeout); /** Called after a user has been successfully invited to a channel. - * You cannot prevent the invite from occuring using this function, to do that, + * You cannot prevent the invite from occurring using this function, to do that, * use OnUserPreInvite instead. * @param source The user who is issuing the INVITE * @param dest The user being invited @@ -639,7 +639,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 tokens The 005 map to be modified if neccessary. + * @param tokens The 005 map to be modified if necessary. */ virtual void On005Numeric(std::map<std::string, std::string>& tokens); @@ -665,7 +665,7 @@ class CoreExport Module : public classbase, public usecountbase * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly * recommended that modules do *NOT* bail if they cannot satisfy dependencies, * but instead operate under reduced functionality, unless the dependency is - * absolutely neccessary (e.g. a module that extends the features of another + * absolutely necessary (e.g. a module that extends the features of another * module). * @param mod A pointer to the new module */ @@ -678,7 +678,7 @@ class CoreExport Module : public classbase, public usecountbase * for example loaded "m_killwidgets.so" with "m_makewidgets.so". It is highly * recommended that modules do *NOT* bail if they cannot satisfy dependencies, * but instead operate under reduced functionality, unless the dependency is - * absolutely neccessary (e.g. a module that extends the features of another + * absolutely necessary (e.g. a module that extends the features of another * module). * @param mod Pointer to the module being unloaded (still valid) */ @@ -686,18 +686,18 @@ class CoreExport Module : public classbase, public usecountbase /** Called once every five seconds for background processing. * This timer can be used to control timed features. Its period is not accurate - * enough to be used as a clock, but it is gauranteed to be called at least once in + * enough to be used as a clock, but it is guaranteed to be called at least once in * any five second period, directly from the main loop of the server. * @param curtime The current timer derived from time(2) */ virtual void OnBackgroundTimer(time_t curtime); /** Called whenever any command is about to be executed. - * This event occurs for all registered commands, wether they are registered in the core, + * This event occurs for all registered commands, whether they are registered in the core, * or another module, and for invalid commands. Invalid commands may only be sent to this * function when the value of validated is false. By returning 1 from this method you may prevent the * command being executed. If you do this, no output is created by the core, and it is - * down to your module to produce any output neccessary. + * down to your module to produce any output necessary. * Note that unless you return 1, you should not destroy any structures (e.g. by using * InspIRCd::QuitUser) otherwise when the command's handler function executes after your * method returns, it will be passed an invalid pointer to the user object and crash!) @@ -711,7 +711,7 @@ class CoreExport Module : public classbase, public usecountbase virtual ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated); /** Called after any command has been executed. - * This event occurs for all registered commands, wether they are registered in the core, + * This event occurs for all registered commands, whether they are registered in the core, * or another module, but it will not occur for invalid commands (e.g. ones which do not * exist within the command table). The result code returned by the command handler is * provided. @@ -768,7 +768,7 @@ class CoreExport Module : public classbase, public usecountbase virtual ModResult OnUserRegister(LocalUser* user); /** Called whenever a user joins a channel, to determine if invite checks should go ahead or not. - * This method will always be called for each join, wether or not the channel is actually +i, and + * This method will always be called for each join, whether or not the channel is actually +i, and * determines the outcome of an if statement around the whole section of invite checking code. * return 1 to explicitly allow the join to go ahead or 0 to ignore the event. * @param user The user joining the channel @@ -791,7 +791,7 @@ class CoreExport Module : public classbase, public usecountbase virtual ModResult OnRawMode(User* user, Channel* chan, ModeHandler* mh, const std::string& param, bool adding); /** Called whenever a user joins a channel, to determine if key checks should go ahead or not. - * This method will always be called for each join, wether or not the channel is actually +k, and + * This method will always be called for each join, whether or not the channel is actually +k, and * determines the outcome of an if statement around the whole section of key checking code. * if the user specified no key, the keygiven string will be a valid but empty value. * return 1 to explicitly allow the join to go ahead or 0 to ignore the event. @@ -803,7 +803,7 @@ class CoreExport Module : public classbase, public usecountbase virtual ModResult OnCheckKey(User* user, Channel* chan, const std::string &keygiven); /** Called whenever a user joins a channel, to determine if channel limit checks should go ahead or not. - * This method will always be called for each join, wether or not the channel is actually +l, and + * This method will always be called for each join, whether or not the channel is actually +l, and * determines the outcome of an if statement around the whole section of channel limit checking code. * return 1 to explicitly allow the join to go ahead or 0 to ignore the event. * @param user The user joining the channel @@ -1057,17 +1057,17 @@ class CoreExport ModuleManager : public fakederef<ModuleManager> void SetPriority(Module* mod, Priority s); /** Attach an event to a module. - * You may later detatch the event with ModuleManager::Detach(). - * If your module is unloaded, all events are automatically detatched. + * You may later detach the event with ModuleManager::Detach(). + * If your module is unloaded, all events are automatically detached. * @param i Event type to attach * @param mod Module to attach event to * @return True if the event was attached */ bool Attach(Implementation i, Module* mod); - /** Detatch an event from a module. + /** Detach an event from a module. * This is not required when your module unloads, as the core will - * automatically detatch your module from all events it is attached to. + * automatically detach your module from all events it is attached to. * @param i Event type to detach * @param mod Module to detach event from * @return True if the event was detached |