diff --git a/public/IAdminSystem.h b/public/IAdminSystem.h index be93cbe9..ea247439 100644 --- a/public/IAdminSystem.h +++ b/public/IAdminSystem.h @@ -196,6 +196,9 @@ namespace SourceMod virtual void OnRebuildOverrideCache() =0; }; + /** + * @brief Admin permission levels. + */ typedef unsigned int FlagBits; /** @@ -487,7 +490,7 @@ namespace SourceMod * @brief Sets a password on an admin. * * @param id AdminId index of the admin. - * @param passwd String containing the password. + * @param password String containing the password. */ virtual void SetAdminPassword(AdminId id, const char *password) =0; @@ -559,7 +562,7 @@ namespace SourceMod * Note: This is a wrapper around GetAdminFlags(). * * @param id AdminId index of admin. - * @param flags Bitstring containing the permissions to check. + * @param bits Bitstring containing the permissions to check. * @return True if user has permission, false otherwise. */ virtual bool CheckAdminFlags(AdminId id, FlagBits bits) =0; diff --git a/public/IGameConfigs.h b/public/IGameConfigs.h index 988f2824..acd5ed8f 100644 --- a/public/IGameConfigs.h +++ b/public/IGameConfigs.h @@ -22,7 +22,7 @@ #include /** - * @file IGameConfig.h + * @file IGameConfigs.h * @brief Abstracts game private data configuration. */ @@ -43,6 +43,9 @@ namespace SourceMod PropType_Data = 2, /**< Property type is a data/save property */ }; + /** + * @brief Details the property states. + */ enum PropError { PropError_Okay = 0, /**< No error */ @@ -71,7 +74,6 @@ namespace SourceMod * @brief Returns information about a dynamic offset. * * @param key Key to retrieve from the property section. - * @param value Pointer to store the offset value. Will be -1 on failure. * @return A PropError error code. */ virtual SendProp *GetSendProp(const char *key) =0; diff --git a/public/IPlayerHelpers.h b/public/IPlayerHelpers.h index 92dae146..1d120a9a 100644 --- a/public/IPlayerHelpers.h +++ b/public/IPlayerHelpers.h @@ -116,6 +116,11 @@ namespace SourceMod class IClientListener { public: + /** + * @brief Returns the current client listener version. + * + * @return Client listener version. + */ virtual unsigned int GetClientListenerVersion() { return SMINTERFACE_PLAYERMANAGER_VERSION; diff --git a/public/ITimerSystem.h b/public/ITimerSystem.h index 23d19353..9a8fb89c 100644 --- a/public/ITimerSystem.h +++ b/public/ITimerSystem.h @@ -19,6 +19,12 @@ #ifndef _INCLUDE_SOURCEMOD_TIMER_SYSTEM_H_ #define _INCLUDE_SOURCEMOD_TIMER_SYSTEM_H_ +/** + * @file ITimerSystem.h + * @brief Contains functions for creating and managing timers. + */ + + #include #include diff --git a/public/IUserMessages.h b/public/IUserMessages.h index d3d8b775..2fe872e4 100644 --- a/public/IUserMessages.h +++ b/public/IUserMessages.h @@ -58,7 +58,7 @@ namespace SourceMod * * @param msg_id Message Id. * @param bf bf_write structure containing written bytes. - * @param pFtiler Recipient filter. + * @param pFilter Recipient filter. * @return Pl_Continue to allow message, Pl_Stop or Pl_Handled to scrap it. */ virtual ResultType InterceptUserMessage(int msg_id, bf_write *bf, IRecipientFilter *pFilter) @@ -68,7 +68,7 @@ namespace SourceMod /** * @brief Called when a hooked user message is sent, regardless of the hook type. - * @param mgs_id Message Id. + * @param msg_id Message Id. */ virtual void OnUserMessageSent(int msg_id) { diff --git a/public/sourcepawn/sp_vm_api.h b/public/sourcepawn/sp_vm_api.h index 531eef4d..634e346d 100644 --- a/public/sourcepawn/sp_vm_api.h +++ b/public/sourcepawn/sp_vm_api.h @@ -833,8 +833,7 @@ namespace SourcePawn /** * @brief Destroys a fake native function wrapper. * - * @param function Pointer to the fake native created by CreateFakeNative. - * @noreturn + * @param func Pointer to the fake native created by CreateFakeNative. */ virtual void DestroyFakeNative(SPVM_NATIVE_FUNC func) =0; };