fixed some doxygen comment typos

--HG--
extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%401684
This commit is contained in:
David Anderson 2007-11-16 01:24:15 +00:00
parent fcb362da09
commit 0e4dc3a565
5 changed files with 9 additions and 9 deletions

View File

@ -624,7 +624,7 @@ namespace SourceMod
/** /**
* @brief Reads a single character as a flag. * @brief Reads a single character as a flag.
* *
* @param flag Flag character. * @param c Flag character.
* @param pAdmFlag Pointer to store the admin flag. * @param pAdmFlag Pointer to store the admin flag.
* @return True on success, false if invalid. * @return True on success, false if invalid.
*/ */
@ -707,7 +707,7 @@ namespace SourceMod
* @brief Computers access to an override. * @brief Computers access to an override.
* *
* @param client Client index. * @param client Client index.
* @param override Override name. * @param cmd Override name.
* @param flags Default flags. * @param flags Default flags.
* @param override_only If false, if a command matches the override, * @param override_only If false, if a command matches the override,
* then its flags will override the default. * then its flags will override the default.

View File

@ -784,7 +784,7 @@ namespace SourceMod
* @param type A DBHandleType value. * @param type A DBHandleType value.
* @param ptr A pointer corrresponding to a DBHandleType * @param ptr A pointer corrresponding to a DBHandleType
* object. * object.
* @param token Identity pointer of the owning identity. * @param pToken Identity pointer of the owning identity.
* @return A new Handle_t handle, or 0 on failure. * @return A new Handle_t handle, or 0 on failure.
*/ */
virtual Handle_t CreateHandle(DBHandleType type, void *ptr, IdentityToken_t *pToken) =0; virtual Handle_t CreateHandle(DBHandleType type, void *ptr, IdentityToken_t *pToken) =0;
@ -814,7 +814,7 @@ namespace SourceMod
* @brief Given a driver name, attempts to find it. If it is not found, SourceMod * @brief Given a driver name, attempts to find it. If it is not found, SourceMod
* will attempt to load it. This function is not thread safe. * will attempt to load it. This function is not thread safe.
* *
* @param name Driver identifier name. * @param driver Driver identifier name.
* @return IDBDriver pointer on success, NULL otherwise. * @return IDBDriver pointer on success, NULL otherwise.
*/ */
virtual IDBDriver *FindOrLoadDriver(const char *driver) =0; virtual IDBDriver *FindOrLoadDriver(const char *driver) =0;

View File

@ -337,7 +337,6 @@ namespace SourceMod
* *
* @param path Path to extension file, relative to the * @param path Path to extension file, relative to the
* extensions folder. * extensions folder.
* @param lifetime Lifetime of the extension (currently ignored).
* @param error Error buffer. * @param error Error buffer.
* @param maxlength Maximum error buffer length. * @param maxlength Maximum error buffer length.
* @return New IExtension on success, NULL on failure. * @return New IExtension on success, NULL on failure.

View File

@ -265,7 +265,7 @@ namespace SourceMod
* @brief Returns whether the display is capable of rendering an item * @brief Returns whether the display is capable of rendering an item
* with the given flags. * with the given flags.
* *
* @param flags ITEMDRAW flags. * @param drawFlags ITEMDRAW flags.
* @return True if renderable, false otherwise. * @return True if renderable, false otherwise.
*/ */
virtual bool CanDrawItem(unsigned int drawFlags) =0; virtual bool CanDrawItem(unsigned int drawFlags) =0;
@ -289,7 +289,7 @@ namespace SourceMod
* @brief Sets the selectable key map. Returns false if the function * @brief Sets the selectable key map. Returns false if the function
* is not supported. * is not supported.
* *
* @param keys A bit string where each bit N-1 specifies * @param keymap A bit string where each bit N-1 specifies
* that key N is selectable (key 0 is bit 9). * that key N is selectable (key 0 is bit 9).
* If the selectable key map is 0, it will be * If the selectable key map is 0, it will be
* automatically set to allow 0. * automatically set to allow 0.
@ -662,6 +662,7 @@ namespace SourceMod
* @brief A display/selection cycle has ended. * @brief A display/selection cycle has ended.
* *
* @param menu Menu pointer. * @param menu Menu pointer.
* @param reason MenuEndReason reason.
*/ */
virtual void OnMenuEnd(IBaseMenu *menu, MenuEndReason reason) virtual void OnMenuEnd(IBaseMenu *menu, MenuEndReason reason)
{ {
@ -740,6 +741,7 @@ namespace SourceMod
* always be called. * always be called.
* *
* @param menu Menu pointer. * @param menu Menu pointer.
* @param reason VoteCancelReason reason.
*/ */
virtual void OnMenuVoteCancel(IBaseMenu *menu, VoteCancelReason reason) virtual void OnMenuVoteCancel(IBaseMenu *menu, VoteCancelReason reason)
{ {

View File

@ -280,7 +280,6 @@ namespace SourceMod
* @param key Key string. * @param key Key string.
* @param value Value string. If no quotes were specified, this will be NULL, * @param value Value string. If no quotes were specified, this will be NULL,
* and key will contain the entire string. * and key will contain the entire string.
* @param Number of line in file.
* @return SMCResult directive. * @return SMCResult directive.
*/ */
virtual SMCResult ReadSMC_KeyValue(const SMCStates *states, const char *key, const char *value) virtual SMCResult ReadSMC_KeyValue(const SMCStates *states, const char *key, const char *value)
@ -291,7 +290,7 @@ namespace SourceMod
/** /**
* @brief Called when leaving the current section. * @brief Called when leaving the current section.
* *
* @param Parsing states. * @param states Parsing states.
* @return SMCResult directive. * @return SMCResult directive.
*/ */
virtual SMCResult ReadSMC_LeavingSection(const SMCStates *states) virtual SMCResult ReadSMC_LeavingSection(const SMCStates *states)