diff options
author | Daniel Friesel <derf@finalrewind.org> | 2016-02-24 17:52:10 +0100 |
---|---|---|
committer | Daniel Friesel <derf@finalrewind.org> | 2016-02-24 17:52:10 +0100 |
commit | 00750ab7749b3f26303020410b5240a4cf26d249 (patch) | |
tree | a90cc9b66e651a80e8f380697de3db3a3cb17fc4 | |
parent | b4293fd7aa24bc020f901c7a383f3e87d34a3b76 (diff) |
update storage documentation
-rw-r--r-- | src/storage.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/src/storage.h b/src/storage.h index 322555b..0193b17 100644 --- a/src/storage.h +++ b/src/storage.h @@ -36,12 +36,16 @@ class Storage { * number of stored animations to zero. The next save operation * will get pattern id 0 and overwrite the first stored pattern. * - * This function does not delete patterns from the EEPROM. However, - * it does reset the pattern counter, thus making all saved patterns - * unavailable to the load and numPatterns functions. + * Note that this function does not write anything to the + * EEPROM. Use Storage::sync() for that. */ void reset(); + /** + * Writes the current number of animations (as set by reset() or + * save() to the EEPROM. Required to get a consistent storage state + * after a power cycle. + */ void sync(); /** |