X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=src%2Fcokebank.h;h=25a356637efde0f6555f40b078338e67b2d56ba7;hb=f02c7f90fe0e654d5587fa88c8dd8297ef150b54;hp=a16c3ae83bc5701beb0f943dc2a702b8ac8cf89d;hpb=e1fdf2ccb6a7b5301e44aaf7927fdb49f511a30d;p=tpg%2Fopendispense2.git

diff --git a/src/cokebank.h b/src/cokebank.h
index a16c3ae..25a3566 100644
--- a/src/cokebank.h
+++ b/src/cokebank.h
@@ -13,26 +13,65 @@
 #define COKEBANK_SALES_ACCT	">sales"	//!< Sales made into
 #define COKEBANK_DEBT_ACCT	">liability"	//!< Credit taken out of
 
-enum eCokebank_Flags {
-	USER_FLAG_TYPEMASK = 0x03,
-	USER_TYPE_NORMAL = 0x00,
-	USER_TYPE_COKE   = 0x01,
-	USER_TYPE_WHEEL  = 0x02,
-	USER_TYPE_GOD    = 0x03,
-	
-	USER_FLAG_DOORGROUP = 0x40,
-	USER_FLAG_DISABLED  = 0x80
+enum eCokebank_Flags {	
+	USER_FLAG_COKE  	= 0x01,
+	USER_FLAG_WHEEL 	= 0x02,
+	USER_FLAG_DOORGROUP	= 0x04,
+	USER_FLAG_INTERNAL	= 0x40,
+	USER_FLAG_DISABLED	= 0x80
 };
 
 // --- Cokebank Functions ---
+/**
+ * \brief Transfer money from one account to another
+ * \param SourceUser	UID (from \a GetUserID) to take the money from
+ * \param DestUser	UID (from \a GetUserID) give money to
+ * \param Ammount	Amount of money (in cents) to transfer
+ * \param Reason	Reason for the transfer
+ */
 extern int	Transfer(int SourceUser, int DestUser, int Ammount, const char *Reason);
+/**
+ * \brief Get flags on an account
+ * \param User	UID to get flags from
+ * \see eCokebank_Flags
+ */
 extern int	GetFlags(int User);
+/**
+ * \brief Set an account's flags
+ * \param User	UID to set flags on
+ * \param Mask	Mask of flags changed
+ * \param Value	Final value of changed flags
+ */
 extern int	SetFlags(int User, int Mask, int Value);
+/**
+ * \brief Get an account's balance
+ * \param User	UID to query
+ */
 extern int	GetBalance(int User);
+/**
+ * \brief Get the name associated with an account
+ * \return Heap string
+ */
 extern char	*GetUserName(int User);
+/**
+ * \brief Get a UID from a passed name
+ */
 extern int	GetUserID(const char *Username);
+/**
+ * \brief Create a new account
+ */
 extern int	CreateUser(const char *Username);
+/**
+ * \brief Get the maximum UID
+ * \note Used for iterating accounts
+ */
 extern int	GetMaxID(void);
+/**
+ * \brief Validates a user's authentication
+ * \param Salt	Salt given to the client for hashing the password
+ * \param Username	Username used
+ * \param Password	Password sent by the client
+ */
 extern int	GetUserAuth(const char *Salt, const char *Username, const char *Password);
 
 #endif