home · contact · privacy
Server/py: Undummify build_fov_map().
[plomrogue] / src / client / command_db.h
index 9f8206201cf10f2b1dbb4e9da105121dd0ac66f6..ff56984807e219e4c413079d4991e7b51d03ed66 100644 (file)
@@ -1,4 +1,8 @@
 /* src/client/command_db.h
+ *
+ * This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
+ * or any later version. For details on its copyright, license, and warranties,
+ * see the file NOTICE in the root directory of the PlomRogue source package.
  *
  * The Command DB collects the commands available to the user by internal name,
  * description and, optionally, components of a message to send to the server
@@ -16,8 +20,8 @@ struct Command
 {
     char * dsc_short; /* short name of command to be used internally */
     char * dsc_long; /* long description of command to be shown to the user */
-    char * server_msg; /* optionally start string of message to send to server */
-    char arg; /* defines server message suffix by player_control() convention */
+    char * server_msg; /* optionally start string of message to send to server*/
+    char arg; /* defines server message suffix by try_server_commands() rules */
 };
 
 struct CommandDB
@@ -28,10 +32,12 @@ struct CommandDB
 
 
 
-/* Return Command struct for command described by its "dsc_short" member. */
+/* Return Command struct for command described by its "dsc_short" member. Return
+ * NULL if no such command is found.
+ */
 extern struct Command * get_command(char * dsc_short);
 
-/* Reads CommandDB from CommandDB file, line by line, until first empty line. */
+/* Read in CommandDB config file. */
 extern void init_command_db();
 
 /* Free all memory allocated with init_command_db. */