# Changes 0.2.4-1

- Add GIT_BRANCH (for development and stable)
- Write  Documentation of
  - pd-core (exept of vec.hpp)
  - pd-app
  - pd-drivers
  - pd-lib3ds
  - pd-image
  - pd-image
  - pd-ui7

include/pd/ui7/theme.hpp

@@ -25,40 +25,51 @@ SOFTWARE.
 
 #include <pd/core/common.hpp>
 
+/**
+ *  Using this to support 32bit color values as well as
+ * values from UI7Color_
+ */
 using UI7Color = PD::u32;
 
+/** Theme Color */
 enum UI7Color_ {
-  UI7Color_Background,
-  UI7Color_Button,
-  UI7Color_ButtonDead,
-  UI7Color_ButtonActive,
-  UI7Color_ButtonHovered,
-  UI7Color_Text,
-  UI7Color_TextDead,
-  UI7Color_Header,
-  UI7Color_Selector,
-  UI7Color_Checkmark,
-  UI7Color_FrameBackground,
-  UI7Color_FrameBackgroundHovered,
-  UI7Color_Progressbar,
-  UI7Color_ListEven,
-  UI7Color_ListOdd,
+  UI7Color_Background,              ///< UI7 Menu Background
+  UI7Color_Button,                  ///< UI7 Button Idle Color
+  UI7Color_ButtonDead,              ///< UI7 Disabled Button Color
+  UI7Color_ButtonActive,            ///< UI7 Pressed Button Color
+  UI7Color_ButtonHovered,           ///< UI7 Hovered Button Color
+  UI7Color_Text,                    ///< UI7 Text Color
+  UI7Color_TextDead,                ///< UI7 Dead Text Color
+  UI7Color_Header,                  ///< UI7 Menu Header Color
+  UI7Color_Selector,                ///< UI7 Selector Color
+  UI7Color_Checkmark,               ///< UI7 Checkmark Color
+  UI7Color_FrameBackground,         ///< UI7 Frame Background
+  UI7Color_FrameBackgroundHovered,  ///< UI7 Hovered Frame Background
+  UI7Color_Progressbar,             ///< UI7 Progressbar Background
+  UI7Color_ListEven,                ///< UI7 List (Even Entry) Background Color
+  UI7Color_ListOdd,                 ///< UI7 List (Odd Entry) Background Color
 };
 
 namespace PD {
 namespace UI7 {
-/// @brief Theme Class
+/** Theme Class */
 class Theme : public SmartCtor<Theme> {
  public:
- public:
+  /**
+   * Default Constructor Setting up the Default theme
+   * @note if using SmartCtor Reference you probably need to do
+   * Theme::Default(*theme.get());
+   */
   Theme() { Default(*this); }
-  ~Theme() {}
+  ~Theme() = default;
 
-  /// @brief Simple static Loader for the Default Theme
-  /// @param theme Theme Reference
+  /**
+   * Simple static Loader for the Default Theme
+   * @param theme Theme Reference
+   */
   static void Default(Theme& theme);
 
-  /// @brief Revert the last Color Change
+  /** Revert the last Color Change */
   Theme& Pop() {
     theme[changes[changes.size() - 1].first] =
         changes[changes.size() - 1].second;
@@ -66,8 +77,10 @@ class Theme : public SmartCtor<Theme> {
     return *this;
   }
 
-  /// @brief Revert the last color Change done for a specific color
-  /// @param c Color to revert change from
+  /**
+   * Revert the last color Change done for a specific color
+   * @param c Color to revert change from
+   */
   Theme& Pop(UI7Color c) {
     for (size_t i = changes.size() - 1; i > 0; i--) {
       if (changes[i].first == c) {
@@ -79,9 +92,11 @@ class Theme : public SmartCtor<Theme> {
     return *this;
   }
 
-  /// @brief Change a Color
-  /// @param tc Color Identifier
-  /// @param color Color to change to
+  /**
+   * Change a Color
+   * @param tc Color Identifier
+   * @param color Color to change to
+   */
   Theme& Change(UI7Color tc, u32 color) {
     if (theme.find(tc) == theme.end()) {
       return *this;
@@ -91,8 +106,10 @@ class Theme : public SmartCtor<Theme> {
     return *this;
   }
 
-  /// @brief Get the Color of a Color ReferenceID
-  /// @param c ReferenceID
+  /**
+   * Get the Color of a Color ReferenceID
+   * @param c ReferenceID
+   */
   u32 Get(UI7Color c) const {
     auto e = theme.find(c);
     if (e == theme.end()) {
@@ -101,18 +118,22 @@ class Theme : public SmartCtor<Theme> {
     return e->second;
   }
 
-  /// @brief Operator wrapper for get
-  /// @param c Color ReferenceID
+  /**
+   * Operator wrapper for get
+   * @param c Color ReferenceID
+   */
   u32 operator[](UI7Color c) const { return Get(c); }
 
-  /// @brief Change but just sets [can implement completly new ids]
-  /// @param tc Color ID (Can be self creeated ones as well)
-  /// @param clr Color it should be set to
+  /**
+   * Change but just sets [can implement completly new ids]
+   * @param tc Color ID (Can be self creeated ones as well)
+   * @param clr Color it should be set to
+   */
   void Set(UI7Color tc, u32 clr) { theme[tc] = clr; }
 
  private:
-  std::unordered_map<u32, u32> theme;
-  std::vector<std::pair<UI7Color, u32>> changes;
+  std::unordered_map<u32, u32> theme;             ///< Theme Data
+  std::vector<std::pair<UI7Color, u32>> changes;  ///< List of Changes
 };
 }  // namespace UI7
 }  // namespace PD