some doxygen fixes
authorBorja Ferrer <faluco@alliedmods.net>
Thu Mar 15 22:32:45 2007 +0000 (2007-03-15)
changeset 620e329c942cb00
parent 619 6934bf39171e
child 621 5a0f5014aac1
some doxygen fixes
public/IAdminSystem.h
public/IGameConfigs.h
public/IPlayerHelpers.h
public/ITimerSystem.h
public/IUserMessages.h
public/sourcepawn/sp_vm_api.h
     1.1 --- a/public/IAdminSystem.h	Thu Mar 15 20:44:23 2007 +0000
     1.2 +++ b/public/IAdminSystem.h	Thu Mar 15 22:32:45 2007 +0000
     1.3 @@ -196,6 +196,9 @@
     1.4  		virtual void OnRebuildOverrideCache() =0;
     1.5  	};
     1.6  
     1.7 +	/**
     1.8 +	 * @brief Admin permission levels.
     1.9 +	 */
    1.10  	typedef unsigned int FlagBits;
    1.11  
    1.12  	/**
    1.13 @@ -487,7 +490,7 @@
    1.14  		 * @brief Sets a password on an admin.
    1.15  		 *
    1.16  		 * @param id		AdminId index of the admin.
    1.17 -		 * @param passwd	String containing the password.
    1.18 +		 * @param password	String containing the password.
    1.19  		 */
    1.20  		virtual void SetAdminPassword(AdminId id, const char *password) =0;
    1.21  
    1.22 @@ -559,7 +562,7 @@
    1.23  		 * Note: This is a wrapper around GetAdminFlags().
    1.24  		 *
    1.25  		 * @param id		AdminId index of admin.
    1.26 -		 * @param flags		Bitstring containing the permissions to check.
    1.27 +		 * @param bits		Bitstring containing the permissions to check.
    1.28  		 * @return			True if user has permission, false otherwise.
    1.29  		 */
    1.30  		virtual bool CheckAdminFlags(AdminId id, FlagBits bits) =0;
     2.1 --- a/public/IGameConfigs.h	Thu Mar 15 20:44:23 2007 +0000
     2.2 +++ b/public/IGameConfigs.h	Thu Mar 15 22:32:45 2007 +0000
     2.3 @@ -22,7 +22,7 @@
     2.4  #include <IShareSys.h>
     2.5  
     2.6  /**
     2.7 - * @file IGameConfig.h
     2.8 + * @file IGameConfigs.h
     2.9   * @brief Abstracts game private data configuration.
    2.10   */
    2.11  
    2.12 @@ -43,6 +43,9 @@
    2.13  		PropType_Data = 2,			/**< Property type is a data/save property */
    2.14  	};
    2.15  
    2.16 +	/**
    2.17 +	 * @brief Details the property states.
    2.18 +	 */
    2.19  	enum PropError
    2.20  	{
    2.21  		PropError_Okay = 0,			/**< No error */
    2.22 @@ -71,7 +74,6 @@
    2.23  		 * @brief Returns information about a dynamic offset.
    2.24  		 *
    2.25  		 * @param key			Key to retrieve from the property section.
    2.26 -		 * @param value			Pointer to store the offset value.  Will be -1 on failure.
    2.27  		 * @return				A PropError error code.
    2.28  		 */
    2.29  		virtual SendProp *GetSendProp(const char *key) =0;
     3.1 --- a/public/IPlayerHelpers.h	Thu Mar 15 20:44:23 2007 +0000
     3.2 +++ b/public/IPlayerHelpers.h	Thu Mar 15 22:32:45 2007 +0000
     3.3 @@ -116,6 +116,11 @@
     3.4  	class IClientListener
     3.5  	{
     3.6  	public:
     3.7 +	   /**
     3.8 +		* @brief Returns the current client listener version.
     3.9 +		*
    3.10 +		* @return		Client listener version.
    3.11 +		*/
    3.12  		virtual unsigned int GetClientListenerVersion()
    3.13  		{
    3.14  			return SMINTERFACE_PLAYERMANAGER_VERSION;
     4.1 --- a/public/ITimerSystem.h	Thu Mar 15 20:44:23 2007 +0000
     4.2 +++ b/public/ITimerSystem.h	Thu Mar 15 22:32:45 2007 +0000
     4.3 @@ -19,6 +19,12 @@
     4.4  #ifndef _INCLUDE_SOURCEMOD_TIMER_SYSTEM_H_
     4.5  #define _INCLUDE_SOURCEMOD_TIMER_SYSTEM_H_
     4.6  
     4.7 +/**
     4.8 + * @file ITimerSystem.h
     4.9 + * @brief Contains functions for creating and managing timers.
    4.10 + */
    4.11 +
    4.12 +
    4.13  #include <IShareSys.h>
    4.14  #include <IForwardSys.h>
    4.15  
     5.1 --- a/public/IUserMessages.h	Thu Mar 15 20:44:23 2007 +0000
     5.2 +++ b/public/IUserMessages.h	Thu Mar 15 22:32:45 2007 +0000
     5.3 @@ -58,7 +58,7 @@
     5.4  		 * 
     5.5  		 * @param msg_id		Message Id.
     5.6  		 * @param bf			bf_write structure containing written bytes.
     5.7 -		 * @param pFtiler		Recipient filter.
     5.8 +		 * @param pFilter		Recipient filter.
     5.9  		 * @return				Pl_Continue to allow message, Pl_Stop or Pl_Handled to scrap it.
    5.10  		 */
    5.11  		virtual ResultType InterceptUserMessage(int msg_id, bf_write *bf, IRecipientFilter *pFilter)
    5.12 @@ -68,7 +68,7 @@
    5.13  
    5.14  		/**
    5.15  		 * @brief Called when a hooked user message is sent, regardless of the hook type.
    5.16 -		 * @param mgs_id		Message Id.
    5.17 +		 * @param msg_id		Message Id.
    5.18  		 */
    5.19  		virtual void OnUserMessageSent(int msg_id)
    5.20  		{
     6.1 --- a/public/sourcepawn/sp_vm_api.h	Thu Mar 15 20:44:23 2007 +0000
     6.2 +++ b/public/sourcepawn/sp_vm_api.h	Thu Mar 15 22:32:45 2007 +0000
     6.3 @@ -833,8 +833,7 @@
     6.4  		/**
     6.5  		 * @brief Destroys a fake native function wrapper.  
     6.6  		 *
     6.7 -		 * @param function	Pointer to the fake native created by CreateFakeNative.
     6.8 -		 * @noreturn
     6.9 +		 * @param func		Pointer to the fake native created by CreateFakeNative.
    6.10  		 */
    6.11  		virtual void DestroyFakeNative(SPVM_NATIVE_FUNC func) =0;
    6.12  	};