Revision 19:8f394a5f3758, committed 2016-12-28

Comitter:

WiredHome

Date:

Wed Dec 28 00:24:39 2016 +0000

Parent:

18:282ed56d983b

Child:

20:392d1ec637eb

Commit message:

Tiny documentation update to clarify the Version 1 to version 2 transition.

Changed in this revision

--- a/IniManager.h	Wed Dec 28 00:21:01 2016 +0000
+++ b/IniManager.h	Wed Dec 28 00:24:39 2016 +0000
@@ -12,7 +12,12 @@
 * It follows an old "Windows" style of ini file format with section, key, and value.
 *
 * @note An API change offers DIFFERENT AND INCOMPATIBLE return values from the 
-*       WriteString and the ReadString APIs. 
+*       WriteString and the ReadString APIs, however it is backward compatible,
+*       requiring a new parameter in the constructor or the SetFile API to 
+*       access the new return values.
+*
+* @note Version 1 by default will be deprecated in a future release, probably 
+*       around mid to late 2017.
 * 
 * As a "simple" ini file manager, this version does not cache anything internally.
 * This comes at the "cost" that each write transaction will read and replace the