From 9bc44384c52efd690ac05409a3e2cca0a6882850 Mon Sep 17 00:00:00 2001
From: Grigoris Pavlakis <grigpavl@ece.auth.gr>
Date: Sun, 18 Aug 2019 21:00:12 +0300
Subject: [PATCH] Update docs

---
 inc/Services/Parameter.hpp        | 3 ++-
 inc/Services/ParameterService.hpp | 2 --
 2 files changed, 2 insertions(+), 3 deletions(-)

diff --git a/inc/Services/Parameter.hpp b/inc/Services/Parameter.hpp
index a63d846b..2cec0f88 100644
--- a/inc/Services/Parameter.hpp
+++ b/inc/Services/Parameter.hpp
@@ -20,6 +20,7 @@
  * @typedef ParamId: the unique ID of a parameter, used for searching
  * @typedef ValueType: the type of the parameter's value (changing types is WIP)
  * @typedef UpdatePtr: pointer to a void function, with a single ValueType* argument (return address)
+ * @typedef Flags: container for the binary flags
  */
 typedef uint16_t ParamId;
 typedef uint32_t ValueType;
@@ -38,7 +39,7 @@ typedef etl::bitset<NUM_OF_FLAGS> Flags;
  *
  * Additional features (not included in standard):
  * @private flags: Various binary flags (number and meaning TBD).
- * Current flag meanings (starting from LSB, big-endian):
+ * @warning Current flag meanings (starting from LSB, big-endian):
  * Index 0: update with priority
  * Index 1: manual update available
  * Index 2: automatic update available
diff --git a/inc/Services/ParameterService.hpp b/inc/Services/ParameterService.hpp
index 0338d76d..49a591b8 100644
--- a/inc/Services/ParameterService.hpp
+++ b/inc/Services/ParameterService.hpp
@@ -9,10 +9,8 @@
 
 // Number of stored parameters. MAX_PARAMS is just a dummy number for now.
 #define MAX_PARAMS 5
-// TODO: 2) Implement flags and use them above
 // TODO: 3) Write more and better tests
 // TODO: 4) Make sure that docs are up to date
-// TODO: 5) Optimize stuff if possible
 
 /**
  * Implementation of the ST[20] parameter management service,
-- 
GitLab