fixed some doxygen comment typos
authorDavid Anderson <dvander@alliedmods.net>
Fri Nov 16 01:24:15 2007 +0000 (2007-11-16)
changeset 1678aad21f87ee38
parent 1677 9e81dcf43499
child 1679 5374868c0f6a
fixed some doxygen comment typos
public/IAdminSystem.h
public/IDBDriver.h
public/IExtensionSys.h
public/IMenuManager.h
public/ITextParsers.h
     1.1 --- a/public/IAdminSystem.h	Tue Nov 13 16:36:50 2007 +0000
     1.2 +++ b/public/IAdminSystem.h	Fri Nov 16 01:24:15 2007 +0000
     1.3 @@ -624,7 +624,7 @@
     1.4  		/**
     1.5  		 * @brief Reads a single character as a flag.
     1.6  		 *
     1.7 -		 * @param flag		Flag character.
     1.8 +		 * @param c			Flag character.
     1.9  		 * @param pAdmFlag	Pointer to store the admin flag.
    1.10  		 * @return			True on success, false if invalid.
    1.11  		 */
    1.12 @@ -707,7 +707,7 @@
    1.13  		 * @brief Computers access to an override.
    1.14  		 *
    1.15  		 * @param client		Client index.
    1.16 -		 * @param override		Override name.
    1.17 +		 * @param cmd			Override name.
    1.18  		 * @param flags			Default flags.
    1.19  		 * @param override_only	If false, if a command matches the override, 
    1.20  		 *						then its flags will override the default.
     2.1 --- a/public/IDBDriver.h	Tue Nov 13 16:36:50 2007 +0000
     2.2 +++ b/public/IDBDriver.h	Fri Nov 16 01:24:15 2007 +0000
     2.3 @@ -784,7 +784,7 @@
     2.4  		 * @param type			A DBHandleType value.
     2.5  		 * @param ptr			A pointer corrresponding to a DBHandleType 
     2.6  		 *						object.
     2.7 -		 * @param token			Identity pointer of the owning identity.
     2.8 +		 * @param pToken		Identity pointer of the owning identity.
     2.9  		 * @return				A new Handle_t handle, or 0 on failure.
    2.10  		 */
    2.11  		virtual Handle_t CreateHandle(DBHandleType type, void *ptr, IdentityToken_t *pToken) =0;
    2.12 @@ -814,7 +814,7 @@
    2.13  		 * @brief Given a driver name, attempts to find it.  If it is not found, SourceMod
    2.14  		 * will attempt to load it.  This function is not thread safe.
    2.15  		 *
    2.16 -		 * @param name			Driver identifier name.
    2.17 +		 * @param driver		Driver identifier name.
    2.18  		 * @return				IDBDriver pointer on success, NULL otherwise.
    2.19  		 */
    2.20  		virtual IDBDriver *FindOrLoadDriver(const char *driver) =0;
     3.1 --- a/public/IExtensionSys.h	Tue Nov 13 16:36:50 2007 +0000
     3.2 +++ b/public/IExtensionSys.h	Fri Nov 16 01:24:15 2007 +0000
     3.3 @@ -337,7 +337,6 @@
     3.4  		 *
     3.5  		 * @param path			Path to extension file, relative to the 
     3.6  		 *						extensions folder.
     3.7 -		 * @param lifetime		Lifetime of the extension (currently ignored).
     3.8  		 * @param error			Error buffer.
     3.9  		 * @param maxlength		Maximum error buffer length.
    3.10  		 * @return				New IExtension on success, NULL on failure.
     4.1 --- a/public/IMenuManager.h	Tue Nov 13 16:36:50 2007 +0000
     4.2 +++ b/public/IMenuManager.h	Fri Nov 16 01:24:15 2007 +0000
     4.3 @@ -265,7 +265,7 @@
     4.4  		 * @brief Returns whether the display is capable of rendering an item
     4.5  		 * with the given flags.
     4.6  		 *
     4.7 -		 * @param flags			ITEMDRAW flags.
     4.8 +		 * @param drawFlags		ITEMDRAW flags.
     4.9  		 * @return				True if renderable, false otherwise.
    4.10  		 */
    4.11  		virtual bool CanDrawItem(unsigned int drawFlags) =0;
    4.12 @@ -289,7 +289,7 @@
    4.13  		 * @brief Sets the selectable key map.  Returns false if the function 
    4.14  		 * is not supported.
    4.15  		 * 
    4.16 -		 * @param keys			A bit string where each bit N-1 specifies 
    4.17 +		 * @param keymap		A bit string where each bit N-1 specifies 
    4.18  		 *						that key N is selectable (key 0 is bit 9).  
    4.19  		 *						If the selectable key map is 0, it will be
    4.20  		 *						automatically set to allow 0.
    4.21 @@ -662,6 +662,7 @@
    4.22  		 * @brief A display/selection cycle has ended.
    4.23  		 *
    4.24  		 * @param menu			Menu pointer.
    4.25 +		 * @param reason		MenuEndReason reason.
    4.26  		 */
    4.27  		virtual void OnMenuEnd(IBaseMenu *menu, MenuEndReason reason)
    4.28  		{
    4.29 @@ -740,6 +741,7 @@
    4.30  		 * always be called.
    4.31  		 *
    4.32  		 * @param menu			Menu pointer.
    4.33 +		 * @param reason		VoteCancelReason reason.
    4.34  		 */
    4.35  		virtual void OnMenuVoteCancel(IBaseMenu *menu, VoteCancelReason reason)
    4.36  		{
     5.1 --- a/public/ITextParsers.h	Tue Nov 13 16:36:50 2007 +0000
     5.2 +++ b/public/ITextParsers.h	Fri Nov 16 01:24:15 2007 +0000
     5.3 @@ -280,7 +280,6 @@
     5.4  		 * @param key			Key string.
     5.5  		 * @param value			Value string.  If no quotes were specified, this will be NULL, 
     5.6  		 *						and key will contain the entire string.
     5.7 -		 * @param 				Number of line in file.
     5.8  		 * @return				SMCResult directive.
     5.9  		 */
    5.10  		virtual SMCResult ReadSMC_KeyValue(const SMCStates *states, const char *key, const char *value)
    5.11 @@ -291,7 +290,7 @@
    5.12  		/**
    5.13  		 * @brief Called when leaving the current section.
    5.14  		 *
    5.15 -		 * @param				Parsing states.
    5.16 +		 * @param states		Parsing states.
    5.17  		 * @return				SMCResult directive.
    5.18  		 */
    5.19  		virtual SMCResult ReadSMC_LeavingSection(const SMCStates *states)