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.