1.1 --- a/plugins/include/admin.inc	Fri May 18 18:00:35 2007 +0000
     1.2 +++ b/plugins/include/admin.inc	Fri May 18 18:05:11 2007 +0000
     1.3 @@ -50,7 +50,7 @@
     1.4  #define AdminFlags_TOTAL	21		/**< Total number of admin flags */
     1.5  
     1.6  /**
     1.7 - * @section These define bitwise values for bitstrings (numbers containing bitwise flags).
     1.8 + * @section Bitwise values definitions for admin flags.
     1.9   */
    1.10  #define ADMFLAG_RESERVATION			(1<<0)		/**< Convenience macro for Admin_Reservation as a FlagBit */
    1.11  #define ADMFLAG_GENERIC				(1<<1)		/**< Convenience macro for Admin_Generic as a FlagBit */
    1.12 @@ -81,25 +81,25 @@
    1.13  /**
    1.14   * @section Hardcoded authentication methods 
    1.15   */
    1.16 -#define AUTHMETHOD_STEAM			"steam"
    1.17 -#define AUTHMETHOD_IP				"ip"
    1.18 -#define AUTHMETHOD_NAME				"name"
    1.19 +#define AUTHMETHOD_STEAM			"steam"		/**< SteamID based authentication */
    1.20 +#define AUTHMETHOD_IP				"ip"		/**< IP based authentication */
    1.21 +#define AUTHMETHOD_NAME				"name"		/**< Name based authentication */
    1.22  
    1.23  /**
    1.24   * @endsection
    1.25   */
    1.26  
    1.27  /**
    1.28 - * Override types.
    1.29 + * Access override types.
    1.30   */
    1.31  enum OverrideType
    1.32  {
    1.33 -	Override_Command = 1,	/* Command */
    1.34 -	Override_CommandGroup,	/* Command group */
    1.35 +	Override_Command = 1,	/**< Command */
    1.36 +	Override_CommandGroup,	/**< Command group */
    1.37  };
    1.38  
    1.39  /**
    1.40 - * Override rules.
    1.41 + * Access override rules.
    1.42   */
    1.43  enum OverrideRule
    1.44  {
    1.45 @@ -112,23 +112,29 @@
    1.46   */
    1.47  enum ImmunityType
    1.48  {
    1.49 -	Immunity_Default = 1,	/* Immune from everyone with no immunity */
    1.50 -	Immunity_Global,		/* Immune from everyone (except root admins) */
    1.51 +	Immunity_Default = 1,	/**< Immune from everyone with no immunity */
    1.52 +	Immunity_Global,		/**< Immune from everyone (except root admins) */
    1.53  };
    1.54  
    1.55 -/** Identifies a unique entry in the group permissions cache.  These are not Handles. */
    1.56 +/** 
    1.57 + * Identifies a unique entry in the group permissions cache.  These are not Handles.
    1.58 + */
    1.59  enum GroupId
    1.60  {
    1.61 -	INVALID_GROUP_ID = -1,
    1.62 +	INVALID_GROUP_ID = -1,	/**< An invalid/nonexistant group */
    1.63  };
    1.64  
    1.65 -/** Identifies a unique entry in the admin permissions cache.  These are not Handles. */
    1.66 +/** 
    1.67 + * Identifies a unique entry in the admin permissions cache.  These are not Handles.
    1.68 + */
    1.69  enum AdminId
    1.70  {
    1.71 -	INVALID_ADMIN_ID = -1,
    1.72 +	INVALID_ADMIN_ID = -1,	/**< An invalid/nonexistant admin */
    1.73  };
    1.74  
    1.75 -/** Defines user access modes. */
    1.76 +/**
    1.77 + * Methods of computing access permissions.
    1.78 + */
    1.79  enum AdmAccessMode
    1.80  {
    1.81  	Access_Real,		/**< Access the user has inherently */
    1.82 @@ -323,6 +329,7 @@
    1.83  
    1.84  /**
    1.85   * Retrieves an admin's user name as made with CreateAdmin().
    1.86 + *
    1.87   * @note This function can return UTF-8 strings, and will safely chop UTF-8 strings.
    1.88   *
    1.89   * @param id			AdminId of the admin.
    1.90 @@ -435,6 +442,7 @@
    1.91  
    1.92  /**
    1.93   * Removes an admin entry from the cache.
    1.94 + *
    1.95   * @note This will remove any bindings to a specific user.
    1.96   *
    1.97   * @param id			AdminId index to remove/invalidate.
    1.98 @@ -528,3 +536,4 @@
    1.99  	
   1.100  	return false;
   1.101  }
   1.102 +