command.h
changeset 1713 d970350410b2
parent 1691 fcd9fefaed02
child 1728 7cd90080eff5
--- a/command.h	Wed Apr 20 22:24:39 2005 +0000
+++ b/command.h	Wed Apr 20 22:30:40 2005 +0000
@@ -177,6 +177,11 @@
 //#define return_cmd_error(errcode) do { _error_message=(errcode); return CMD_ERROR; } while(0)
 #define return_cmd_error(errcode) do { return CMD_ERROR | (errcode); } while (0)
 
+/**
+ * Check the return value of a DoCommand*() function
+ * @param res the resulting value from the command to be checked
+ * @return Return true if the command failed, false otherwise
+ */
 static inline bool CmdFailed(int32 res)
 {
 	// lower 16bits are the StringID of the possible error