From 70180a7eb9b2168022ee43a48b1ad432d458b300 Mon Sep 17 00:00:00 2001
From: rusefi <arro239+rusefi@gmail.com>
Date: Sat, 3 Feb 2018 12:40:17 -0500
Subject: [PATCH] docs

---
 firmware/util/LocalVersionHolder.cpp | 4 +++-
 firmware/util/LocalVersionHolder.h   | 9 +++++++++
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/firmware/util/LocalVersionHolder.cpp b/firmware/util/LocalVersionHolder.cpp
index c7bc51475f..ab8d8faa7b 100644
--- a/firmware/util/LocalVersionHolder.cpp
+++ b/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
diff --git a/firmware/util/LocalVersionHolder.h b/firmware/util/LocalVersionHolder.h
index 6906b1cf78..871277eb7e 100644
--- a/firmware/util/LocalVersionHolder.h
+++ b/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();