Make the docs state that KConfig::reparseConfiguration() calls sync() if needed

This matches the method actually does, and makes it clearer that you don't
need to do config->sync() followed by config()->reparseConfiguration(), the
latter should suffice.

1 files changed, 2 insertions, 0 deletions

diff --git a/src/core/kconfig.h b/src/core/kconfig.h
index 792a9a6b..6fee5ff5 100644
--- a/src/core/kconfig.h
+++ b/src/core/kconfig.h
@@ -233,6 +233,8 @@ public:
 
     /**
      * Updates the state of this object to match the persistent storage.
+     * Note that if this object has pending changes, this method will
+     * call sync() first so as not to lose those changes.
      */
     void reparseConfiguration();