Update comments for Doxygen. Move old, unused files to the testing folder.

[matches/MCTX3420.git] / server / control.h

diff --git a/server/control.h b/server/control.h
index 0dfdc47..e623033 100644 (file)
--- a/server/control.h
+++ b/server/control.h
@@ -5,6 +5,10 @@
 #ifndef _CONTROL_H
 #define _CONTROL_H
 
+/** 
+ * The possible experiment control modes that the server can be in.
+ * At present, CONTROL_EMERGENCY largely does nothing. TODO: Fix this
+ */
 typedef enum ControlModes {
        CONTROL_START,
        CONTROL_PAUSE,
@@ -17,12 +21,12 @@ typedef enum ControlModes {
 #define INVALID_CHARACTERS "\"*/:<>?\\|. "
 /** The same as INVALID_CHARACTERS, except escaped for use in JSON strings **/
 #define INVALID_CHARACTERS_JSON "\\\"*/:<>?\\\\|. "
-
+/** The username of a user with no authentication (DEBUG ONLY) **/
 #define NOAUTH_USERNAME "_anonymous_noauth"
 
 extern void Control_Handler(FCGIContext *context, char *params);
 extern const char* Control_SetMode(ControlModes desired_mode, void * arg);
-extern ControlModes Control_GetMode();
+//extern ControlModes Control_GetMode();
 extern const char * Control_GetModeName();
 //extern bool Control_Lock();
 //extern void Control_Unlock();