Update to README / documentation of applications for the release

[tinyos-2.x.git] / apps / tests / TestPrintf / TestPrintfC.nc

diff --git a/apps/tests/TestPrintf/TestPrintfC.nc b/apps/tests/TestPrintf/TestPrintfC.nc
index 79f3f0862e205fa67be221bfce392c3a0c0e937a..c9b0716076f99eaa0b08c87e388f54f4def5db75 100644 (file)
--- a/apps/tests/TestPrintf/TestPrintfC.nc
+++ b/apps/tests/TestPrintf/TestPrintfC.nc
@@ -21,6 +21,13 @@
  */
  
 /**
+ *
+ * This application is used to test the basic functionality of the printf service.  
+ * It is initiated by calling the start() command of the SplitControl interface 
+ * provided by the PrintfC component.  After starting the printf service, calls to 
+ * the standard c-style printf command are made to print various strings of text 
+ * over the serial line.  Only upon calling PrintfFlush.flush() does the data 
+ * actually get sent out over the serial line.
  *
  * @author Kevin Klues (klueska@cs.wustl.edu)
  * @version $Revision$