From 27ede4aedd9a9dc094da7705c8bd23e148704335 Mon Sep 17 00:00:00 2001
From: sallai <sallai>
Date: Mon, 23 Jun 2008 21:05:13 +0000
Subject: [PATCH] added a README.txt, updated source code documentation

---
 apps/tests/TestPrintf/README.txt        | 24 ++++++++++++++++++++++++
 apps/tests/TestPrintf/TestPrintfAppC.nc | 14 ++++++--------
 apps/tests/TestPrintf/TestPrintfC.nc    | 14 ++++++--------
 3 files changed, 36 insertions(+), 16 deletions(-)
 create mode 100644 apps/tests/TestPrintf/README.txt

diff --git a/apps/tests/TestPrintf/README.txt b/apps/tests/TestPrintf/README.txt
new file mode 100644
index 00000000..b38bc437
--- /dev/null
+++ b/apps/tests/TestPrintf/README.txt
@@ -0,0 +1,24 @@
+$Id$
+
+README for TestPrintf
+Author/Contact: tinyos-help@millennium.berkeley.edu
+
+Description:
+This application is used to test the basic functionality of 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() does the
+data actually get sent out over the serial line.
+
+Tools:
+
+net.tinyos.tools.PrintfClient is a Java application that displays the output on
+the PC.
+
+Usage:
+
+java net.tinyos.tools.PrintfClient -comm serial@<serial port>:<mote>
+
+Known bugs/limitations:
+
+None.
+ 
\ No newline at end of file
diff --git a/apps/tests/TestPrintf/TestPrintfAppC.nc b/apps/tests/TestPrintf/TestPrintfAppC.nc
index db8bb2f0..9332725a 100644
--- a/apps/tests/TestPrintf/TestPrintfAppC.nc
+++ b/apps/tests/TestPrintf/TestPrintfAppC.nc
@@ -19,20 +19,18 @@
  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
  * MODIFICATIONS."
  */
- 
+
 /**
- * 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.
+ * This application is used to test the basic functionality of 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() does the
+ * data actually get sent out over the serial line.
  *
  * @author Kevin Klues (klueska@cs.wustl.edu)
  * @version $Revision$
  * @date $Date$
  */
- 
+
 #include "printf.h"
 
 configuration TestPrintfAppC{
diff --git a/apps/tests/TestPrintf/TestPrintfC.nc b/apps/tests/TestPrintf/TestPrintfC.nc
index 9d35c464..cb968d00 100644
--- a/apps/tests/TestPrintf/TestPrintfC.nc
+++ b/apps/tests/TestPrintf/TestPrintfC.nc
@@ -19,15 +19,13 @@
  * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
  * MODIFICATIONS."
  */
- 
+
 /**
  *
- * 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.
+ * This application is used to test the basic functionality of 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() does the
+ * data actually get sent out over the serial line.
  *
  * @author Kevin Klues (klueska@cs.wustl.edu)
  * @version $Revision$
@@ -41,7 +39,7 @@ module TestPrintfC {
   }
 }
 implementation {
-	
+
   uint8_t dummyVar1 = 123;
   uint16_t dummyVar2 = 12345;
   uint32_t dummyVar3 = 1234567890;
-- 
2.39.2