Diff: ConfigFile.h

Revision:

3:31c936f3b9df

Parent:

2:ba316099c799

Child:

4:466a2aeaae75

--- a/ConfigFile.h	Thu Jan 27 21:36:01 2011 +0000
+++ b/ConfigFile.h	Thu Jan 27 21:41:03 2011 +0000
@@ -1,4 +1,4 @@
-/**
+/*
  * ConfigFile.cpp
  * Simple Config file reader class
  *
@@ -18,18 +18,24 @@
  *
  *   You should have received a copy of the GNU General Public License
  *   along with LaOS.  If not, see <http://www.gnu.org/licenses/>.
- *
+ */
+/**
  * Reads a setting, based on the key. (case sensitive)
  * If the key is not found, the default value is returned.
  *
  * Simple, not (time) efficient. For every request, the complete file is reset and read again
+ * 
  * file format:
  *
  * ; comment
  * key value [newline || comment]
  *
- *
- * note: NULL key does nothing
+ * @code
+ *; This is a test config file
+ * ip 192.168.1.1
+ * port 1234 ; the key is "port" the value is "1234". The rest is comment
+ *; EOF
+ * @endcode
  */
 
 #include "mbed.h"