Joris Aerts / ConfigFile

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of ConfigFile by peter brier

Files at this revision

API Documentation at this revision

Revision 3:31c936f3b9df, committed 2011-01-27

Comitter:
pbrier
Date:
Thu Jan 27 21:41:03 2011 +0000
Parent:
2:ba316099c799
Child:
4:466a2aeaae75
Commit message:
1.11

Changed in this revision

ConfigFile.cpp Show annotated file Show diff for this revision Revisions of this file
ConfigFile.h Show annotated file Show diff for this revision Revisions of this file 
--- a/ConfigFile.cpp	Thu Jan 27 21:36:01 2011 +0000
+++ b/ConfigFile.cpp	Thu Jan 27 21:41:03 2011 +0000
@@ -1,4 +1,4 @@
-/**
+/*
  * ConfigFile.cpp
  * Simple Config file reader class
  *

--- 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"