Diff: IniManager.h

Revision:

6:cd28ab597256

Parent:

5:bfeb0882bd82

Child:

8:f128b10dfab1

--- a/IniManager.h	Wed Mar 26 11:20:18 2014 +0000
+++ b/IniManager.h	Sun Apr 20 13:36:09 2014 +0000
@@ -29,9 +29,11 @@
 class INI
 {
 public:
-    /** constructor accepts a filename
+    /** Constructor for an INI file interface.
     *
-    * @param file is the filename to manage. Memory is allocated to hold
+    * Constructor for an INI file interface.
+    *
+    * @param[in] file is the filename to manage. Memory is allocated to hold
     *       a private copy of the filename. Be sure that this parameter
     *       has the right path prefix based on what file system you have.
     */
@@ -48,7 +50,7 @@
     * If not set at the time of construction, or if a change is needed, this
     * API can be used.
     *
-    * @param file is the filename to manage.
+    * @param[in] file is the filename to manage.
     * @returns true if success, false if memory could not be allocated.
     */
     bool SetFile(const char * file);
@@ -58,11 +60,11 @@
     * This searches the ini file for the named section and key and if found it will
     * return the string associated with that entry into a user supplied buffer.
     * 
-    * @param section is the name of the section to search.
-    * @param key is the name of the key to search.
-    * @param buffer is the caller provided buffer for this method to put the string into.
-    * @param bufferSize is the caller provided declaration of the available space.
-    * @param defaultString is an optional parameter that sets the buffer if the section/key is not found.
+    * @param[in] section is the name of the section to search.
+    * @param[in] key is the name of the key to search.
+    * @param[out] buffer is the caller provided buffer for this method to put the string into.
+    * @param[in] bufferSize is the caller provided declaration of the available space.
+    * @param[in] defaultString is an optional parameter that sets the buffer if the section/key is not found.
     * 
     * @return true if the section, key, and value are found AND the value will fit in the buffer
     *       in which case it is written into the buffer; false otherwise.
@@ -73,9 +75,9 @@
     *
     * This writes a given string into an ini file in the named section and key.
     * 
-    * @param section is the name of the section to search.
-    * @param key is the name of the key to search.
-    * @param buffer is the caller provided buffer containing the string to write. If
+    * @param[in] section is the name of the section to search.
+    * @param[in] key is the name of the key to search.
+    * @param[in] buffer is the caller provided buffer containing the string to write. If
     *       buffer is NULL, then any existing entry is removed.
     *
     * @return true if the write was successful; false otherwise.
@@ -98,8 +100,8 @@
     *
     * This version also works on the local file system.
     *
-    * @param oldfname is the old file name
-    * @param newfname is the new file name
+    * @param[in] oldfname is the old file name
+    * @param[in] newfname is the new file name
     * @returns 0 on success, -1 on error
     */
     int Rename(const char *oldfname, const char *newfname);
@@ -108,8 +110,8 @@
     *
     * This version also works on the local file system.
     *
-    * @param src is the source file
-    * @param dst is the destination file
+    * @param[in] src is the source file
+    * @param[in] dst is the destination file
     * @returns 0 on success, -1 on error
     */
     int Copy(const char *src, const char *dst);