Ben Katz / ExperimentServer

Fork of ExperimentServer by Patrick Wensing

Revision:
5:195f5f47b56f
Parent:
0:85e387719efd
Child:
7:405d66abdedf
diff -r 63635482312f -r 195f5f47b56f ExperimentServer.h
--- a/ExperimentServer.h	Tue Aug 11 21:14:17 2015 +0000
+++ b/ExperimentServer.h	Thu Aug 13 17:00:25 2015 +0000
@@ -8,8 +8,22 @@
 class ExperimentServer
 {
 public:
+     /**
+     * Constructor.
+     *
+     * Constructs an empty experiment server. Server objects require further
+     * initialization before use.
+     */
     ExperimentServer();
+    
+     /**
+     *
+     * Links a serial terminal with the server for debugging.
+     *
+     * @param terminal Serial terminal to be used for debug messages
+     */
     void attachTerminal( Serial & terminal); 
+    
     void init(const char * addr, const char * subnet, const char * host, unsigned int port);
     
     int getParams(float params[], int num_params);