Revert "Revert "examples prepared for release""

davetcc · davetcc · commit 1f3bcac601e7 · 2022-12-30T14:30:33.000Z
This reverts commit 4c17a47.
diff --git a/README.md b/README.md
@@ -44,9 +44,8 @@ If you are manually using tcMenu, without the designer, this page fully document
 
 ## Asking questions
 
-There is a forum where questions can be asked, but the rules of engagement are: **this is my hobby, I make it available because it helps others**. Don't expect immediate answers, make sure you've recreated the problem in a simple sketch that you can send to me. Please consider making at least a one time donation using the sponsor link above before using the forum.
-
-* [TCC Community forum](https://www.thecoderscorner.com/jforum/)
-* [Commercial support](https://www.thecoderscorner.com/all-contact)
-* I also monitor the Arduino forum [https://forum.arduino.cc/], Arduino related questions can be asked there too, please make sure the library name is in the subject.
+You can ask questions either in the [discussions section of the tcMenu repo](https://github.com/davetcc/tcMenu/discussions), or using the Arduino forum. We generally answer most questions, but the rules of engagement are: **this is my hobby, I make it available because it helps others**. Don't expect immediate answers, make sure you've recreated the problem in a simple sketch that you can send to me. Please consider making at least a one time donation using the sponsor link if we do help you out.
 
+* [discussions section of the tcMenu repo](https://github.com/davetcc/tcMenu/discussions) of tcmenu git repo
+* [Arduino discussion forum](https://forum.arduino.cc/) where questions can be asked, please tag me using `@davetcc`.
+* [Legacy discussion forum probably to be made read only soon](https://www.thecoderscorner.com/jforum/).
diff --git a/examples/esp/esp32SimHub/dashboardSetup.cpp b/examples/esp/esp32SimHub/dashboardSetup.cpp
@@ -21,11 +21,12 @@ void CustomDashboardDelegate::dashboardDidDraw(unsigned int encVal, RenderPressM
     if(!ledsChanged) return;
     ledsChanged = false;
     int widthOfOneLed = renderer.getDeviceDrawable()->getDisplayDimensions().x / LED_STATES;
+    int startX = widthOfOneLed / 2;
 
-    int offsetX = widthOfOneLed / 2;
     for (uint16_t ledState : ledColors) {
-        renderer.getDeviceDrawable()->drawCircle(Coord(offsetX, offsetX), offsetX - 1, ledState);
-        offsetX += widthOfOneLed;
+        renderer.getDeviceDrawable()->setDrawColor(ledState);
+        renderer.getDeviceDrawable()->drawCircle(Coord(startX, 12), 11, true);
+        startX += widthOfOneLed;
     }
 }
 
@@ -68,12 +69,12 @@ void setupDashboard() {
     serdebugF("Starting dashboard setup");
     dashCustomDrawing = new DrawableDashboard(renderer.getDeviceDrawable(), &renderer, nullptr, DrawableDashboard::DASH_ON_RESET_CLICK_EXIT);
     dashCustomDrawing->clearItems();
-    dashCustomDrawing->addDrawingItem(&menuGear, Coord(15, 60), &gearDrawParams, 1);
-    dashCustomDrawing->addDrawingItem(&menuTyreTemp, Coord(145, 125), &white18ptUpdateRightParam, 5, "TMP");
-    dashCustomDrawing->addDrawingItem(&menuRPM, Coord(145, 45), &rpmDrawParams, 5);
-    dashCustomDrawing->addDrawingItem(&menuSpeed, Coord(145, 85), &white18ptNoUpdate, 5, "MPH");
-    dashCustomDrawing->addDrawingItem(&menuDashboard, Coord(5, 220), &yellow9PtUpdateLeft, 10);
-    dashCustomDrawing->addDrawingItem(&menuLap, Coord(200, 220), &yellow9PtUpdateRight, 5);
+    dashCustomDrawing->addDrawingItem(&menuGear, Coord(15, 50), &gearDrawParams, 1);
+    dashCustomDrawing->addDrawingItem(&menuTyreTemp, Coord(125, 125), &white18ptUpdateRightParam, 5, "TMP");
+    dashCustomDrawing->addDrawingItem(&menuRPM, Coord(125, 45), &rpmDrawParams, 5);
+    dashCustomDrawing->addDrawingItem(&menuSpeed, Coord(125, 85), &white18ptNoUpdate, 5, "MPH");
+    dashCustomDrawing->addDrawingItem(&menuDashboard, Coord(5, 215), &yellow9PtUpdateLeft, 10);
+    dashCustomDrawing->addDrawingItem(&menuLap, Coord(200, 215), &yellow9PtUpdateRight, 5);
     dashCustomDrawing->setDelegate(&dashboardDelegate);
     serdebugF("Finished dash setup");
 
diff --git a/src/BaseDialog.h b/src/BaseDialog.h
@@ -8,11 +8,8 @@
 
 /**
  * @file BaseDialog.h
- * 
- * The definition of the base dialog object, that can be used with any display type. These are designed
+ * @brief The definition of the base dialog object, that can be used with any display type. These are designed
  * to handle simple user informational pages and questions.
- * 
- * Dialogs are a core function of tcMenu, and must be supported on all available platforms.
  */
 
 #define FIRST_DEFAULT_BUTTON 0
diff --git a/src/BaseRenderers.h b/src/BaseRenderers.h
@@ -3,6 +3,11 @@
  * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
  */
 
+/**
+ * @file BaseRenderers.h
+ * @brief The base definitions and classes shared by all TcMenu renderers.
+ */
+
 #ifndef _BASE_RENDERERS_H_
 #define _BASE_RENDERERS_H_
 
diff --git a/src/EditableLargeNumberMenuItem.h b/src/EditableLargeNumberMenuItem.h
@@ -11,7 +11,7 @@
 
 /**
  * @file EditableLargeNumberMenuItem.h
- * This file contains the classes needed to edit very large number values that could not be edited with a rotary encoder.
+ * @brief This file contains the classes needed to edit very large number values that could not be edited with a rotary encoder.
  * These numeric values have 12 digits, and as many decimal places as required.
  */
 
diff --git a/src/EepromItemStorage.h b/src/EepromItemStorage.h
@@ -8,7 +8,7 @@
 
 /**
  * @file EepromItemStorage.h
- * this file contains a series of helper methods for loading and saving menu item to eeprom.
+ * @brief this file contains a series of helper methods for loading and saving menu item to eeprom.
  */
 
 #include "EepromAbstraction.h"
diff --git a/src/MenuHistoryNavigator.h b/src/MenuHistoryNavigator.h
@@ -4,7 +4,8 @@
  */
 
 /**
- * @file MenuHistoryNavigator.h contains the functionality to do with menu item navigation, including a stack of
+ * @file MenuHistoryNavigator.h
+ * @brief contains the functionality to do with menu item navigation, including a stack of
  * previous navigations
  */
 
diff --git a/src/MenuItems.h b/src/MenuItems.h
@@ -5,13 +5,10 @@
 
 /**
  * @file MenuItems.h
- * 
- * In TcMenu, MenuItem storage is shared between program memory and RAM. Usually each MenuItem has associated Info block and
+ * @brief In TcMenu, MenuItem storage is shared between program memory and RAM. Usually each MenuItem has associated Info block and
  * within the InfoBlock, the first fields must be in the same order as AnyMenuInfo. The most commonly used menu items are
  * defined within this file. Each menu item also has a menu item type that is used during rendering and remote communication
  * to determine what it actually is.
- * 
- * Most of the editable menu items can stored to EEPROM, including AnalogMenuItem, EnumMenuItem, BooleanMenuItem and TextMenuItem
  */
 
 #ifndef _MENUITEMS_h
diff --git a/src/MenuIterator.h b/src/MenuIterator.h
@@ -7,8 +7,7 @@
 
 /**
  * @file MenuIterator.h
- * 
- * Provides a number of utility functions for the processing of menu item structures.
+ * @brief Provides a number of utility functions for the processing of menu item structures.
  */
 
 #ifndef _MENUITERATOR_H
diff --git a/src/MessageProcessors.h b/src/MessageProcessors.h
@@ -14,8 +14,7 @@
 
 /**
  * @file MessageProcessors.h
- * 
- * This file contains the default processors that can deal with incoming messages turning
+ * @brief This file contains the default processors that can deal with incoming messages turning
  * them into events on tcMenu.
  */
 
diff --git a/src/RemoteAuthentication.h b/src/RemoteAuthentication.h
@@ -5,7 +5,7 @@
 
 /**
  * @file RemoteAuthentication.h
- * Contains the base functionality for communication between the menu library and remote APIs.
+ * @brief Contains the base functionality for communication between the menu library and remote APIs.
  */
 
 #ifndef _REMOTE_AUTHENTICATION_H_
diff --git a/src/RemoteConnector.h b/src/RemoteConnector.h
@@ -5,7 +5,7 @@
 
 /**
  * @file RemoteConnector.h
- * Contains the base functionality for communication between the menu library and remote APIs.
+ * @brief Contains the base functionality for communication between the menu library and remote APIs.
  */
 
 #ifndef _TCMENU_REMOTECONNECTOR_H_
diff --git a/src/RemoteMenuItem.h b/src/RemoteMenuItem.h
@@ -8,8 +8,7 @@
 
 /**
  * @file RemoteMenuItem.h
- *
- * This file contains the extra types needed for remote menu items, they are not in the main MenuItems.h header because
+ * @brief This file contains the extra types needed for remote menu items, they are not in the main MenuItems.h header because
  * they require all the remote headers be included.
  */
 
diff --git a/src/RemoteTypes.h b/src/RemoteTypes.h
@@ -4,8 +4,7 @@
  */
 /**
  * @file RemoteTypes.h
- * 
- * contains the definitions of each message and field.
+ * @brief contains the definitions of each message and field.
  */
 
 #ifndef _TCMENU_REMOTETYPES_H_
diff --git a/src/RuntimeMenuItem.h b/src/RuntimeMenuItem.h
@@ -5,7 +5,7 @@
 
 /**
  * @file RuntimeMenuItem.h
- * Contains definitions of menu items that can be fully defined at runtime with no need for prog mem structures.
+ * @brief Contains definitions of menu items that can be fully defined at runtime with no need for prog mem structures.
  */
 
 #ifndef _RUNTIME_MENUITEM_H_
diff --git a/src/ScrollChoiceMenuItem.h b/src/ScrollChoiceMenuItem.h
@@ -4,7 +4,8 @@
  */
 
 /**
- * @file ScrollChoiceMenuItem.h contains the menu item definition for scrolling choice types, and also for RGB items
+ * @file ScrollChoiceMenuItem.h
+ * @brief contains the menu item definition for scrolling choice types, and also for RGB items
  */
 
 #ifndef SCROLL_CHOICE_ENUM_MENU_ITEM_H
diff --git a/src/SecuredMenuPopup.h b/src/SecuredMenuPopup.h
@@ -7,7 +7,8 @@
 #define _SECURED_MENU_POPUP_H_
 
 /**
- * @file SecuredMenuPopup.h contains the code to show a security screen for secured menus.
+ * @file SecuredMenuPopup.h
+ * @brief contains the code to show a security screen for secured menus.
  */
 
 #include <RuntimeMenuItem.h>
diff --git a/src/extras/DrawableDashboard.cpp b/src/extras/DrawableDashboard.cpp
@@ -182,7 +182,6 @@ void DashMenuItem::setFont(DashDrawParameters* params, UnicodeFontHandler* unico
 }
 
 void DashMenuItem::paintTitle(DeviceDrawable* drawableRoot) {
-    int baseline;
     UnicodeFontHandler* unicodeHandler = drawableRoot->getUnicodeHandler(true);
     setFont(parameters, unicodeHandler);
     titleExtents = unicodeHandler->textExtents(titleText, &baseline);
@@ -199,7 +198,7 @@ void DashMenuItem::paintTitle(DeviceDrawable* drawableRoot) {
     wrapper.getDrawable()->drawBox(wrapper.offsetLocation(screenLoc), Coord(titleExtents.x + valueWidth, titleExtents.y), true);
 
     unicodeHandler->setDrawColor(wrapper.fgColUnderlying());
-    unicodeHandler->setCursor(wrapper.offsetLocation(screenLoc, startX, titleExtents.y));
+    unicodeHandler->setCursor(wrapper.offsetLocation(screenLoc, startX, titleExtents.y - baseline));
     setFont(parameters, unicodeHandler);
     unicodeHandler->print(titleText);
 
@@ -224,7 +223,7 @@ void DashMenuItem::paintItem(DeviceDrawable* drawableRoot) {
         Coord valueLen = unicodeHandler->textExtents(sz, &baseline);
         padding = valueWidth - (valueLen.x + 4);
     }
-    unicodeHandler->setCursor(wrapper.offsetLocation(screenLoc, padding, unicodeHandler->getYAdvance()));
+    unicodeHandler->setCursor(wrapper.offsetLocation(screenLoc, padding, unicodeHandler->getYAdvance() - baseline));
     unicodeHandler->print(sz);
 
     wrapper.endDraw();
diff --git a/src/extras/DrawableDashboard.h b/src/extras/DrawableDashboard.h
@@ -2,6 +2,11 @@
 #ifndef TCMENU_DRAWABLE_DASHBOARD_H
 #define TCMENU_DRAWABLE_DASHBOARD_H
 
+/**
+ * @file
+ * @brief DrawableDashboard.h a series of helper classes for building dashboards out of menu items.
+ */
+
 #include "BaseRenderers.h"
 #include <tcUnicodeHelper.h>
 #include <graphics/GraphicsDeviceRenderer.h>
@@ -158,6 +163,7 @@ class DashMenuItem {
     int numChars;
     int valueWidth;
     int countDownTicks;
+    int baseline;
     char titleText[20];
 public:
     DashMenuItem() : item(nullptr), screenLoc(0, 0), parameters(nullptr), updateCountDown(0), titleExtents(0, 0),
diff --git a/src/extras/DrawableTouchCalibrator.h b/src/extras/DrawableTouchCalibrator.h
@@ -3,6 +3,11 @@
  * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
  */
 
+/**
+ * @file DrawableTouchCalibrator.h
+ * @brief A simple helper for touch calibration implemented as a TcMenu CustomDrawing instance
+ */
+
 #ifndef TCMENU_DRAWABLETOUCHCALIBRATOR_H
 #define TCMENU_DRAWABLETOUCHCALIBRATOR_H
 
diff --git a/src/extras/MenuItemDelegate.h b/src/extras/MenuItemDelegate.h
@@ -7,7 +7,8 @@
 #define TCMENU_MENUITEMDELEGATE_H
 
 /**
- * @file MenuItemDelegate.h contains a delegate class that allows some menu item operations on more than one item at once
+ * @file
+ * @brief MenuItemDelegate.h contains a delegate class that allows some menu item operations on more than one item at once
  */
 
 #include <MenuItems.h>
diff --git a/src/graphics/BaseGraphicalRenderer.h b/src/graphics/BaseGraphicalRenderer.h
@@ -5,7 +5,7 @@
 
 /**
  * @file BaseGraphicalRenderer.h
- * Contains the base functionality for all graphical renderers.
+ * @brief Contains the base functionality for all graphical renderers.
  */
 
 #ifndef TCMENU_BASEGRAPHICALRENDERER_H
diff --git a/src/graphics/DialogRuntimeEditor.h b/src/graphics/DialogRuntimeEditor.h
@@ -12,7 +12,7 @@
 
 /**
  * @file DialogRuntimeEditor.h
- * Contains the functionality to handle editing runtime multipart items
+ * @brief Contains the functionality to handle editing runtime multipart items
  */
 
 
diff --git a/src/graphics/DrawingPrimitives.h b/src/graphics/DrawingPrimitives.h
@@ -3,7 +3,10 @@
  * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
  */
 
-/** @file DrawingPrimitives.h contains a series of core components needed by all graphical renderers */
+/**
+ * @file DrawingPrimitives.h
+ * @brief contains a series of core components needed by all graphical renderers
+ */
 
 #ifndef TCMENU_DRAWING_PRIMITIVES_H
 #define TCMENU_DRAWING_PRIMITIVES_H
diff --git a/src/graphics/GfxMenuConfig.h b/src/graphics/GfxMenuConfig.h
@@ -6,9 +6,8 @@
 /**
  * @file GfxMenuConfig.h
  *
- * This file contains the base drawing configuration structures and helper methods for
- * drawing onto graphical screens, be it mono or colour. Also there's some additional
- * structures for describing colours, coordinates and padding.
+ * @brief This file contains the base drawing structures and helper methods for drawing onto graphical
+ * screens, be it mono or colour.
  */
 
 #ifndef _GFX_MENU_CONFIG_H_
diff --git a/src/graphics/GraphicsDeviceRenderer.h b/src/graphics/GraphicsDeviceRenderer.h
@@ -4,7 +4,8 @@
  */
 
 /**
- * @file GraphicsDeviceRenderer.h the interface that all graphics devices should implement to do the actual graphics rendering.
+ * @file GraphicsDeviceRenderer.h
+ * @brief the interface that all graphics devices should implement to do the actual graphics rendering.
  */
 
 #ifndef TCLIBRARYDEV_GRAPHICSDEVICERENDERER_H
diff --git a/src/graphics/MenuTouchScreenEncoder.h b/src/graphics/MenuTouchScreenEncoder.h
@@ -4,7 +4,8 @@
  */
 
 /**
- * @file MenuTouchScreenEncoder.h contains the interface between the touch screen and tcMenu.
+ * @file MenuTouchScreenEncoder.h
+ * @brief contains the interface between the touch screen and tcMenu.
  */
 
 #ifndef TCMENU_MENUTOUCHSCREENENCODER_H
diff --git a/src/graphics/RuntimeTitleMenuItem.h b/src/graphics/RuntimeTitleMenuItem.h
@@ -4,7 +4,8 @@
  */
 
 /**
- * @file RuntimeTitleMenuItem.h the menu item that is presented for the title
+ * @file RuntimeTitleMenuItem.h
+ * @brief the menu item that is presented for the title
  */
 
 #ifndef TCMENU_RUNTIMETITLEMENUITEM_H
diff --git a/src/remote/BaseBufferedRemoteTransport.h b/src/remote/BaseBufferedRemoteTransport.h
@@ -3,6 +3,11 @@
  * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
  */
 
+/**
+ * @file BaseBufferedRemoteTransport.h
+ * @brief helper classes for dealing with buffering remote transports
+ */
+
 #ifndef TCMENU_BASEBUFFEREDREMOTETRANSPORT_H
 #define TCMENU_BASEBUFFEREDREMOTETRANSPORT_H
 
diff --git a/src/remote/BaseRemoteComponents.h b/src/remote/BaseRemoteComponents.h
@@ -4,7 +4,8 @@
  */
 
 /**
- * @file BaseRemoteComponents.h contains remote components that are shared across all remote devices.
+ * @file BaseRemoteComponents.h
+ * @brief contains remote components that are shared across all remote devices.
  */
 
 #ifndef TCMENU_BASEREMOTECOMPONENTS_H
diff --git a/src/stockIcons/wifiAndConnectionIcons16x12.h b/src/stockIcons/wifiAndConnectionIcons16x12.h
@@ -10,8 +10,7 @@
 
 /**
  * @file wifiAndConnectionIcons16x12.h
- * 
- * Contains definitions for standard icons including the connection active icon and the wifi signal strength icon.
+ * @brief Contains definitions for standard icons including the connection active icon and the wifi signal strength icon.
  * Icons in this file are all 16 x 12 pixels for medium to high res displays.
  */
 
diff --git a/src/stockIcons/wifiAndConnectionIcons8x7.h b/src/stockIcons/wifiAndConnectionIcons8x7.h
@@ -9,9 +9,8 @@
 #include <PlatformDetermination.h>
 
 /**
- * @file wifiAndConnectionIcons8x8.h
- * 
- * Contains definitions for standard icons including the connection active icon and the wifi signal strength icon.
+ * @file wifiAndConnectionIcons8x7.h
+ * @brief Contains definitions for standard icons including the connection active icon and the wifi signal strength icon.
  * Icons in this file are all 8 x 8 pixels for low res displays.
  */
 
diff --git a/src/stockIcons/wifiAndConnectionIconsLCD.h b/src/stockIcons/wifiAndConnectionIconsLCD.h
@@ -9,9 +9,8 @@
 #include <PlatformDetermination.h>
 
 /**
- * @file wifiAndConnectionIconLCD.h
- * 
- * Contains definitions for standard icons including the connection active icon and the wifi signal strength icon.
+ * @file wifiAndConnectionIconsLCD.h
+ * @brief Contains definitions for standard icons including the connection active icon and the wifi signal strength icon.
  * Icons in this file are for use on LCD display and are arranged to show as custom characters.
  */
 
diff --git a/src/tcMenu.cpp b/src/tcMenu.cpp
diff --git a/src/tcMenu.h b/src/tcMenu.h
diff --git a/src/tcMenuKeyboard.h b/src/tcMenuKeyboard.h
diff --git a/src/tcMenuVersion.h b/src/tcMenuVersion.h
diff --git a/src/tcUtil.h b/src/tcUtil.h
diff --git a/src/tcm_test/testFixtures.h b/src/tcm_test/testFixtures.h
