From: John Hodge <tpg@ucc.asn.au>
Date: Tue, 27 Dec 2011 23:15:49 +0000 (+0800)
Subject: Commenting in server.c
X-Git-Url: https://git.ucc.asn.au/?p=tpg%2Fopendispense2.git;a=commitdiff_plain;h=3b9de73f2264b8688d7814b0013076c8b81a1a5c;ds=sidebyside

Commenting in server.c
---

diff --git a/src/server/server.c b/src/server/server.c
index 2bcd8d3..e392f73 100644
--- a/src/server/server.c
+++ b/src/server/server.c
@@ -811,6 +811,8 @@ tItem *_GetItemFromString(char *String)
 
 /**
  * \brief Fetch information on a specific item
+ *
+ * Usage: ITEMINFO <item ID>
  */
 void Server_Cmd_ITEMINFO(tClient *Client, char *Args)
 {
@@ -831,6 +833,11 @@ void Server_Cmd_ITEMINFO(tClient *Client, char *Args)
 	Server_int_SendItem( Client, item );
 }
 
+/**
+ * \brief Dispense an item
+ *
+ * Usage: DISPENSE <Item ID>
+ */
 void Server_Cmd_DISPENSE(tClient *Client, char *Args)
 {
 	tItem	*item;
@@ -872,6 +879,11 @@ void Server_Cmd_DISPENSE(tClient *Client, char *Args)
 	}
 }
 
+/**
+ * \brief Refund an item to a user
+ *
+ * Usage: REFUND <user> <item id> [<price>]
+ */
 void Server_Cmd_REFUND(tClient *Client, char *Args)
 {
 	tItem	*item;
@@ -920,6 +932,11 @@ void Server_Cmd_REFUND(tClient *Client, char *Args)
 	}
 }
 
+/**
+ * \brief Transfer money to another account
+ *
+ * Usage: GIVE <dest> <ammount> <reason...>
+ */
 void Server_Cmd_GIVE(tClient *Client, char *Args)
 {
 	char	*recipient, *ammount, *reason;