Update dhooks.inc documentation for consistency (#1658)

* Update dhooks.inc documentation for consistency

- Modifies whitespace (change tabs to spaces for non initial indents, fix alignments, create consistency with rest of SM docs)
- Change `/*` to `/**` for consistency and to indicate comment doc
- Removes incorrect `@noreturn` doc

* Split long comments across multiple lines

* Remove `@noreturn` in IGameConfigs.h

* Remove `@noreturn` from IGameHelpers.h

* Remove `@noreturn` from asm.c

* Add `@noreturn` to ThrowError

* Add `@noreturn` and `@error` to ThrowNativeError
This commit is contained in:
Arron Vinyard
2023-08-30 22:08:45 +02:00
committed by Your Name
parent 370fa8209b
commit 210219030e
6 changed files with 363 additions and 337 deletions
-2
View File
@@ -158,7 +158,6 @@ namespace SourceMod
*
* @param sectionname Section name to hook.
* @param listener Listener callback.
* @noreturn
*/
virtual void AddUserConfigHook(const char *sectionname, ITextListener_SMC *listener) =0;
@@ -167,7 +166,6 @@ namespace SourceMod
*
* @param sectionname Section name to unhook.
* @param listener Listener callback.
* @noreturn
*/
virtual void RemoveUserConfigHook(const char *sectionname, ITextListener_SMC *listener) =0;
-1
View File
@@ -188,7 +188,6 @@ namespace SourceMod
*
* @param hndl CBaseHandle object.
* @param pEnt Edict pointer.
* @noreturn
*/
virtual void SetHandleEntity(CBaseHandle &hndl, edict_t *pEnt) =0;
-1
View File
@@ -24,7 +24,6 @@
*
* @param dest Destination buffer where a call opcode + addr (5 bytes) has just been written.
* @param pc The program counter value that needs to be set (usually the next address from the source).
* @noreturn
*/
void check_thunks(unsigned char *dest, unsigned char *pc)
{