docs

firmware/util/LocalVersionHolder.cpp

@@ -7,9 +7,11 @@
 
 #include "LocalVersionHolder.h"
 
+/**
+ * we rely on external source of global version
+ */
 int getGlobalConfigurationVersion(void);
 
-//ctor
 LocalVersionHolder::LocalVersionHolder() {
 	/**
 	 * we want local version to be 'old' on instantiation

firmware/util/LocalVersionHolder.h

@@ -10,10 +10,19 @@
 
 #include "stdbool.h"
 
+/**
+ * this
+ */
 class LocalVersionHolder {
 public:
 	LocalVersionHolder();
 
+	/**
+	 * Calling this method changes the internal state of the class - each consumer interested in tracking
+	 * changes should have it's own instance of this class
+	 *
+	 * @return true if getGlobalConfigurationVersion() has changed since last time we've invoked this method
+	 */
 	bool isOld();
 	int getVersion();