some doxygen fixes

--HG--
extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%40626
This commit is contained in:
Borja Ferrer 2007-03-15 22:32:45 +00:00
parent 279c102ddc
commit b45b71fdd2
6 changed files with 23 additions and 8 deletions

View File

@ -196,6 +196,9 @@ namespace SourceMod
virtual void OnRebuildOverrideCache() =0; virtual void OnRebuildOverrideCache() =0;
}; };
/**
* @brief Admin permission levels.
*/
typedef unsigned int FlagBits; typedef unsigned int FlagBits;
/** /**
@ -487,7 +490,7 @@ namespace SourceMod
* @brief Sets a password on an admin. * @brief Sets a password on an admin.
* *
* @param id AdminId index of the 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; virtual void SetAdminPassword(AdminId id, const char *password) =0;
@ -559,7 +562,7 @@ namespace SourceMod
* Note: This is a wrapper around GetAdminFlags(). * Note: This is a wrapper around GetAdminFlags().
* *
* @param id AdminId index of admin. * @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. * @return True if user has permission, false otherwise.
*/ */
virtual bool CheckAdminFlags(AdminId id, FlagBits bits) =0; virtual bool CheckAdminFlags(AdminId id, FlagBits bits) =0;

View File

@ -22,7 +22,7 @@
#include <IShareSys.h> #include <IShareSys.h>
/** /**
* @file IGameConfig.h * @file IGameConfigs.h
* @brief Abstracts game private data configuration. * @brief Abstracts game private data configuration.
*/ */
@ -43,6 +43,9 @@ namespace SourceMod
PropType_Data = 2, /**< Property type is a data/save property */ PropType_Data = 2, /**< Property type is a data/save property */
}; };
/**
* @brief Details the property states.
*/
enum PropError enum PropError
{ {
PropError_Okay = 0, /**< No error */ PropError_Okay = 0, /**< No error */
@ -71,7 +74,6 @@ namespace SourceMod
* @brief Returns information about a dynamic offset. * @brief Returns information about a dynamic offset.
* *
* @param key Key to retrieve from the property section. * @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. * @return A PropError error code.
*/ */
virtual SendProp *GetSendProp(const char *key) =0; virtual SendProp *GetSendProp(const char *key) =0;

View File

@ -116,6 +116,11 @@ namespace SourceMod
class IClientListener class IClientListener
{ {
public: public:
/**
* @brief Returns the current client listener version.
*
* @return Client listener version.
*/
virtual unsigned int GetClientListenerVersion() virtual unsigned int GetClientListenerVersion()
{ {
return SMINTERFACE_PLAYERMANAGER_VERSION; return SMINTERFACE_PLAYERMANAGER_VERSION;

View File

@ -19,6 +19,12 @@
#ifndef _INCLUDE_SOURCEMOD_TIMER_SYSTEM_H_ #ifndef _INCLUDE_SOURCEMOD_TIMER_SYSTEM_H_
#define _INCLUDE_SOURCEMOD_TIMER_SYSTEM_H_ #define _INCLUDE_SOURCEMOD_TIMER_SYSTEM_H_
/**
* @file ITimerSystem.h
* @brief Contains functions for creating and managing timers.
*/
#include <IShareSys.h> #include <IShareSys.h>
#include <IForwardSys.h> #include <IForwardSys.h>

View File

@ -58,7 +58,7 @@ namespace SourceMod
* *
* @param msg_id Message Id. * @param msg_id Message Id.
* @param bf bf_write structure containing written bytes. * @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. * @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) 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. * @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) virtual void OnUserMessageSent(int msg_id)
{ {

View File

@ -833,8 +833,7 @@ namespace SourcePawn
/** /**
* @brief Destroys a fake native function wrapper. * @brief Destroys a fake native function wrapper.
* *
* @param function Pointer to the fake native created by CreateFakeNative. * @param func Pointer to the fake native created by CreateFakeNative.
* @noreturn
*/ */
virtual void DestroyFakeNative(SPVM_NATIVE_FUNC func) =0; virtual void DestroyFakeNative(SPVM_NATIVE_FUNC func) =0;
}; };