Shinichiro Nakamura / ConfigFile

ConfigFile

Dependents:   ConfigFile_TestProgram StarBoardOrangeExpansion1 StarBoardOrangeExpansion2 Drive2ChoroQ ... more

Diff: ConfigFile.h

Revision:
6:f6ceafabe9f8
Parent:
5:56d544b8e5c6
--- a/ConfigFile.h	Wed Sep 15 12:23:15 2010 +0000
+++ b/ConfigFile.h	Wed Sep 15 13:49:15 2010 +0000
@@ -61,8 +61,24 @@
      */
     bool removeAll(void);
 
+    /**
+     * Get a number of configuration sets.
+     *
+     * @return number of configuration sets.
+     */
     int getCount();
-    
+
+    /**
+     * Get a key and a value.
+     *
+     * @param index Index number of this list.
+     * @param key A pointer to a buffer for key.
+     * @param keybufsiz A size of the key buffer.
+     * @param value A pointer to a buffer for value.
+     * @param valuebufsiz A size of the value buffer.
+     *
+     * @return true if it succeed.
+     */
     bool getKeyAndValue(int index, char *key, size_t keybufsiz, char *value, size_t valuebufsiz);
 
     /**