1.1 --- a/plugins/include/admin.inc Thu Mar 15 20:10:25 2007 +0000
1.2 +++ b/plugins/include/admin.inc Thu Mar 15 20:44:23 2007 +0000
1.3 @@ -47,10 +47,10 @@
1.4 /* --- */
1.5 };
1.6
1.7 -#define AdminFlags_TOTAL 21
1.8 +#define AdminFlags_TOTAL 21 /**< Total number of admin flags */
1.9
1.10 /**
1.11 - * These define bitwise values for bitstrings (numbers containing bitwise flags).
1.12 + * @section These define bitwise values for bitstrings (numbers containing bitwise flags).
1.13 */
1.14 #define ADMFLAG_RESERVATION (1<<0) /**< Convenience macro for Admin_Reservation as a FlagBit */
1.15 #define ADMFLAG_GENERIC (1<<1) /**< Convenience macro for Admin_Generic as a FlagBit */
1.16 @@ -74,22 +74,42 @@
1.17 #define ADMFLAG_CUSTOM5 (1<<19) /**< Convenience macro for Admin_Custom5 as a FlagBit */
1.18 #define ADMFLAG_CUSTOM6 (1<<20) /**< Convenience macro for Admin_Custom6 as a FlagBit */
1.19
1.20 +/**
1.21 + * @endsection
1.22 + */
1.23 +
1.24 +/**
1.25 + * @section Hardcoded authentication methods
1.26 + */
1.27 #define AUTHMETHOD_STEAM "steam"
1.28 #define AUTHMETHOD_IP "ip"
1.29 #define AUTHMETHOD_NAME "name"
1.30
1.31 +/**
1.32 + * @endsection
1.33 + */
1.34 +
1.35 +/**
1.36 + * Override types.
1.37 + */
1.38 enum OverrideType
1.39 {
1.40 Override_Command = 1, /* Command */
1.41 Override_CommandGroup, /* Command group */
1.42 };
1.43
1.44 +/**
1.45 + * Override rules.
1.46 + */
1.47 enum OverrideRule
1.48 {
1.49 Command_Deny = 0,
1.50 Command_Allow = 1,
1.51 };
1.52
1.53 +/**
1.54 + * Immunity types.
1.55 + */
1.56 enum ImmunityType
1.57 {
1.58 Immunity_Default = 1, /* Immune from everyone with no immunity */
1.59 @@ -303,8 +323,7 @@
1.60
1.61 /**
1.62 * Retrieves an admin's user name as made with CreateAdmin().
1.63 - *
1.64 - * NOTE: This function can return UTF-8 strings, and will safely chop UTF-8 strings.
1.65 + * @note This function can return UTF-8 strings, and will safely chop UTF-8 strings.
1.66 *
1.67 * @param id AdminId of the admin.
1.68 * @param name String buffer to store name.
1.69 @@ -416,8 +435,7 @@
1.70
1.71 /**
1.72 * Removes an admin entry from the cache.
1.73 - *
1.74 - * Note: This will remove any bindings to a specific user.
1.75 + * @note This will remove any bindings to a specific user.
1.76 *
1.77 * @param id AdminId index to remove/invalidate.
1.78 * @return True on success, false otherwise.
2.1 --- a/plugins/include/clients.inc Thu Mar 15 20:10:25 2007 +0000
2.2 +++ b/plugins/include/clients.inc Thu Mar 15 20:44:23 2007 +0000
2.3 @@ -254,7 +254,6 @@
2.4 */
2.5 native bool:CanUserTarget(client, target);
2.6
2.7 -
2.8 /**
2.9 * Creates a fake client.
2.10 *
3.1 --- a/plugins/include/console.inc Thu Mar 15 20:10:25 2007 +0000
3.2 +++ b/plugins/include/console.inc Thu Mar 15 20:44:23 2007 +0000
3.3 @@ -19,8 +19,8 @@
3.4 #define _console_included
3.5
3.6 /**
3.7 - * Flags for console commands and console variables
3.8 - * @note The descriptions for each constant come directly from the Source SDK.
3.9 + * @section Flags for console commands and console variables. The descriptions
3.10 + * for each constant come directly from the Source SDK.
3.11 */
3.12 #define FCVAR_NONE 0 /**< The default, no flags at all */
3.13 #define FCVAR_UNREGISTERED (1<<0) /**< If this is set, don't add to linked list, etc. */
3.14 @@ -53,6 +53,10 @@
3.15 #define FCVAR_VPHYSICS (1<<27) /**< Defined by vphysics. */
3.16
3.17 /**
3.18 + * @endsection
3.19 + */
3.20 +
3.21 +/**
3.22 * Executes a server command as if it were on the server console (or RCON)
3.23 *
3.24 * @param format Formatting rules.
4.1 --- a/plugins/include/core.inc Thu Mar 15 20:10:25 2007 +0000
4.2 +++ b/plugins/include/core.inc Thu Mar 15 20:44:23 2007 +0000
4.3 @@ -72,6 +72,9 @@
4.4 PlInfo_URL, /**< Plugin URL */
4.5 };
4.6
4.7 +/**
4.8 + * Defines how an extension must expose itself for autoloading.
4.9 + */
4.10 struct Extension
4.11 {
4.12 const String:name[], /* Short name */
5.1 --- a/plugins/include/entity.inc Thu Mar 15 20:10:25 2007 +0000
5.2 +++ b/plugins/include/entity.inc Thu Mar 15 20:44:23 2007 +0000
5.3 @@ -276,6 +276,10 @@
5.4 native SetEntDataVector(entity, offset, const Float:vec[3], bool:changeState=false);
5.5
5.6 /**
5.7 + * @endsection
5.8 + */
5.9 +
5.10 +/**
5.11 * Given a ServerClass name, finds a networkable send property offset.
5.12 * This information is cached for future calls.
5.13 *
6.1 --- a/plugins/include/events.inc Thu Mar 15 20:10:25 2007 +0000
6.2 +++ b/plugins/include/events.inc Thu Mar 15 20:44:23 2007 +0000
6.3 @@ -33,6 +33,9 @@
6.4 EventHookMode_PostNoCopy /**< Hook callback fired after event is fired, but event data won't be copied */
6.5 };
6.6
6.7 +/**
6.8 + * Hook function types for events.
6.9 + */
6.10 funcenum EventHook
6.11 {
6.12 /**
7.1 --- a/plugins/include/files.inc Thu Mar 15 20:10:25 2007 +0000
7.2 +++ b/plugins/include/files.inc Thu Mar 15 20:44:23 2007 +0000
7.3 @@ -18,8 +18,11 @@
7.4 #endif
7.5 #define _files_included
7.6
7.7 -/* @note All paths in SourceMod natives are relative to the mod folder unless otherwise noted. */
7.8 -
7.9 +/* @global All paths in SourceMod natives are relative to the mod folder unless otherwise noted. */
7.10 +
7.11 +/**
7.12 + * File inode types.
7.13 + */
7.14 enum FileType
7.15 {
7.16 FileType_Unknown = 0, /* Unknown file type (device/socket) */
7.17 @@ -27,15 +30,18 @@
7.18 FileType_File = 2, /* File is a file */
7.19 };
7.20
7.21 -#define PLATFORM_MAX_PATH 256
7.22 +#define PLATFORM_MAX_PATH 256 /**< Maximum path length. */
7.23
7.24 -#define SEEK_SET 0
7.25 -#define SEEK_CUR 1
7.26 -#define SEEK_END 2
7.27 +#define SEEK_SET 0 /**< Seek from start. */
7.28 +#define SEEK_CUR 1 /**< Seek from current position. */
7.29 +#define SEEK_END 2 /**< Seek from end position. */
7.30
7.31 +/**
7.32 + * Path types.
7.33 + */
7.34 enum PathType
7.35 {
7.36 - Path_SM, /* SourceMod root folder */
7.37 + Path_SM, /**< SourceMod root folder */
7.38 };
7.39
7.40 /**
8.1 --- a/plugins/include/float.inc Thu Mar 15 20:10:25 2007 +0000
8.2 +++ b/plugins/include/float.inc Thu Mar 15 20:44:23 2007 +0000
8.3 @@ -19,18 +19,14 @@
8.4 #define _float_included
8.5
8.6 /**
8.7 - * @GLOBAL@
8.8 - * All the trigonometric functions take in or return its values in RADIANS.
8.9 - * Use DegToRad or RadToDeg stocks to convert the radix units.
8.10 + * Different methods of rounding.
8.11 */
8.12 -
8.13 -/* Different methods of rounding */
8.14 enum floatround_method
8.15 {
8.16 - floatround_round = 0,
8.17 - floatround_floor,
8.18 - floatround_ceil,
8.19 - floatround_tozero
8.20 + floatround_round = 0, /**< Standard IEEE rounding */
8.21 + floatround_floor, /**< Next lowest integer value. */
8.22 + floatround_ceil, /**< Next highest integer value. */
8.23 + floatround_tozero /** Closest integer to zero. */
8.24 };
8.25
8.26 /**
8.27 @@ -164,10 +160,10 @@
8.28 native Float:Tangent(Float:value);
8.29
8.30 /**
8.31 - * Returns the absolute value.
8.32 + * Returns an absolute value.
8.33 *
8.34 * @param value Input value.
8.35 - * @return abs(value).
8.36 + * @return Absolute value of the input.
8.37 */
8.38 native Float:FloatAbs(Float:value);
8.39
8.40 @@ -304,11 +300,23 @@
8.41
8.42 #define FLOAT_PI 3.1415926535897932384626433832795
8.43
8.44 +/**
8.45 + * Converts degrees to radians.
8.46 + *
8.47 + * @param angle Degrees.
8.48 + * @return Radians.
8.49 + */
8.50 stock Float:DegToRad(Float:angle)
8.51 {
8.52 return (angle*FLOAT_PI)/180;
8.53 }
8.54
8.55 +/**
8.56 + * Converts degrees to radians.
8.57 + *
8.58 + * @param angle Radians.
8.59 + * @return Degrees.
8.60 + */
8.61 stock Float:RadToDeg(Float:angle)
8.62 {
8.63 return (angle*180)/FLOAT_PI;
9.1 --- a/plugins/include/geoip.inc Thu Mar 15 20:10:25 2007 +0000
9.2 +++ b/plugins/include/geoip.inc Thu Mar 15 20:44:23 2007 +0000
9.3 @@ -21,8 +21,7 @@
9.4 #include <core>
9.5
9.6 /**
9.7 - * @GLOBAL@
9.8 - * IP address can contain ports, the ports will be stripped out.
9.9 + * @section IP addresses can contain ports, the ports will be stripped out.
9.10 */
9.11
9.12 /**
9.13 @@ -54,6 +53,10 @@
9.14 native GeoipCountry(const String:ip[], String:name[], len=45);
9.15
9.16 /**
9.17 + * @endsection
9.18 + */
9.19 +
9.20 +/**
9.21 * Do not edit below this line!
9.22 */
9.23 public Extension:__ext_geoip =
10.1 --- a/plugins/include/handles.inc Thu Mar 15 20:10:25 2007 +0000
10.2 +++ b/plugins/include/handles.inc Thu Mar 15 20:44:23 2007 +0000
10.3 @@ -18,6 +18,9 @@
10.4 #endif
10.5 #define _handles_included
10.6
10.7 +/**
10.8 + * Handle helper macros.
10.9 + */
10.10 enum Handle
10.11 {
10.12 INVALID_HANDLE = 0,
11.1 --- a/plugins/include/sorting.inc Thu Mar 15 20:10:25 2007 +0000
11.2 +++ b/plugins/include/sorting.inc Thu Mar 15 20:44:23 2007 +0000
11.3 @@ -20,7 +20,7 @@
11.4 #define _sorting_included
11.5
11.6 /**
11.7 - * @brief Contains sorting orders.
11.8 + * Contains sorting orders.
11.9 */
11.10 enum SortOrder
11.11 {
12.1 --- a/plugins/include/sourcemod.inc Thu Mar 15 20:10:25 2007 +0000
12.2 +++ b/plugins/include/sourcemod.inc Thu Mar 15 20:44:23 2007 +0000
12.3 @@ -18,13 +18,16 @@
12.4 #endif
12.5 #define _sourcemod_included
12.6
12.7 +/**
12.8 + * Plugin public information.
12.9 + */
12.10 struct Plugin
12.11 {
12.12 - const String:name[], /* Plugin Name */
12.13 - const String:description[], /* Plugin Description */
12.14 - const String:author[], /* Plugin Author */
12.15 - const String:version[], /* Plugin Version */
12.16 - const String:url[], /* Plugin URL */
12.17 + const String:name[], /**< Plugin Name */
12.18 + const String:description[], /**< Plugin Description */
12.19 + const String:author[], /**< Plugin Author */
12.20 + const String:version[], /**< Plugin Version */
12.21 + const String:url[], /**< Plugin URL */
12.22 };
12.23
12.24 #include <core>
12.25 @@ -56,7 +59,7 @@
12.26 /**
12.27 * Called when the plugin is fully initialized and all known external references are resolved.
12.28 * This is called even if the plugin type is "private."
12.29 - * NOTE: Errors in this function will cause the plugin to stop running.
12.30 + * @note Errors in this function will cause the plugin to stop running.
12.31 *
12.32 * @noreturn
12.33 */
12.34 @@ -68,8 +71,8 @@
12.35 * not available at this point. Thus, this forward should only be used for explicit
12.36 * pre-emptive things, such as adding dynamic natives, or setting certain types of load filters.
12.37 *
12.38 - * NOTE: It is not safe to call externally resolved natives until OnPluginStart().
12.39 - * NOTE: Any sort of RTE in this function will cause the plugin to fail loading.
12.40 + * @note It is not safe to call externally resolved natives until OnPluginStart().
12.41 + * @note Any sort of RTE in this function will cause the plugin to fail loading.
12.42 *
12.43 * @param myself Handle to the plugin.
12.44 * @param late Whether or not the plugin was loaded "late" (after map load).
13.1 --- a/plugins/include/string.inc Thu Mar 15 20:10:25 2007 +0000
13.2 +++ b/plugins/include/string.inc Thu Mar 15 20:44:23 2007 +0000
13.3 @@ -19,10 +19,9 @@
13.4 #define _string_included
13.5
13.6 /**
13.7 - * @GLOBAL@
13.8 - * Unless otherwise noted, all string functions which take in a writable buffer and maximum length
13.9 - * should have the null terminator INCLUDED in the length. This means that this is valid:
13.10 - * StrCopy(string, sizeof(string), ...)
13.11 + * @global Unless otherwise noted, all string functions which take in a writable buffer
13.12 + * and maximum length should have the null terminator INCLUDED in the length. This means
13.13 + * that this is valid: StrCopy(string, sizeof(string), ...)
13.14 */
13.15
13.16 /**
13.17 @@ -75,8 +74,8 @@
13.18
13.19 /**
13.20 * Copies one string to another string.
13.21 - * NOTE: If the destination buffer is too small to hold the source string,
13.22 - * the destination will be truncated.
13.23 + * @note If the destination buffer is too small to hold the source string, the
13.24 + * destination will be truncated.
13.25 *
13.26 * @param dest Destination string buffer to copy to.
13.27 * @param destlen Destination buffer length (includes null terminator).
13.28 @@ -99,7 +98,7 @@
13.29 /**
13.30 * Formats a string according to the SourceMod format rules (see documentation).
13.31 * @note This is the same as Format(), except none of the input buffers can overlap the same
13.32 - * memory as the output buffer. Since this security check is removed, it is slightly faster.
13.33 + * memory as the output buffer. Since this security check is removed, it is slightly faster.
13.34 *
13.35 * @param buffer Destination string buffer.
13.36 * @param maxlength Maximum length of output string buffer.
13.37 @@ -112,8 +111,8 @@
13.38 /**
13.39 * Formats a string according to the SourceMod format rules (see documentation).
13.40 * @note This is the same as Format(), except it grabs parameters from a parent parameter
13.41 - * stack, rather than a local. This is useful for implementing your own variable argument
13.42 - * functions.
13.43 + * stack, rather than a local. This is useful for implementing your own variable
13.44 + * argument functions.
13.45 *
13.46 * @param buffer Destination string buffer.
13.47 * @param maxlength Maximum length of output string buffer.
14.1 --- a/plugins/include/textparse.inc Thu Mar 15 20:10:25 2007 +0000
14.2 +++ b/plugins/include/textparse.inc Thu Mar 15 20:44:23 2007 +0000
14.3 @@ -25,6 +25,9 @@
14.4 * The file format itself is nearly identical to Valve's KeyValues format.
14.5 ********************************/
14.6
14.7 +/**
14.8 + * Parse result directive.
14.9 + */
14.10 enum SMCResult
14.11 {
14.12 SMCParse_Continue, /**< Continue parsing */
14.13 @@ -32,6 +35,9 @@
14.14 SMCParse_HaltFail /**< Stop parsing and return failure */
14.15 };
14.16
14.17 +/**
14.18 + * Parse error codes.
14.19 + */
14.20 enum SMCError
14.21 {
14.22 SMCError_Okay = 0, /**< No error */
15.1 --- a/plugins/include/usermessages.inc Thu Mar 15 20:10:25 2007 +0000
15.2 +++ b/plugins/include/usermessages.inc Thu Mar 15 20:44:23 2007 +0000
15.3 @@ -18,6 +18,9 @@
15.4 #endif
15.5 #define _eventsmsgs_included
15.6
15.7 +/**
15.8 + * UserMsg helper values.
15.9 + */
15.10 enum UserMsg
15.11 {
15.12 INVALID_MESSAGE_ID = -1,
16.1 --- a/plugins/include/version.inc Thu Mar 15 20:10:25 2007 +0000
16.2 +++ b/plugins/include/version.inc Thu Mar 15 20:44:23 2007 +0000
16.3 @@ -18,8 +18,8 @@
16.4 #endif
16.5 #define _version_included
16.6
16.7 -#define SOURCEMOD_V_MAJOR 1
16.8 -#define SOURCEMOD_V_MINOR 0
16.9 -#define SOURCEMOD_V_RELEASE 0
16.10 +#define SOURCEMOD_V_MAJOR 1 /**< SourceMod Major version */
16.11 +#define SOURCEMOD_V_MINOR 0 /**< SourceMod Minor version */
16.12 +#define SOURCEMOD_V_RELEASE 0 /**< SourceMod Release version */
16.13
16.14 -#define SOURCEMOD_VERSION "1.0.0.577"
16.15 +#define SOURCEMOD_VERSION "1.0.0.577" /**< SourceMod version string (major.minor.release.build) */
