doc: Fix build and update docs to fix inconsistencies (#421)

Author: finger563

.gitmodules

@@ -1,7 +1,7 @@
-[submodule "external/fmt"]
+[submodule "components/format/detail/fmt"]
 	path = components/format/detail/fmt
 	url = https://github.com/fmtlib/fmt
-[submodule "external/alpaca"]
+[submodule "components/serialization/detail/alpaca"]
 	path = components/serialization/detail/alpaca
 	url = https://github.com/p-ranav/alpaca
 [submodule "components/esp_littlefs"]
@@ -13,28 +13,28 @@
 [submodule "components/esp-dsp"]
 	path = components/esp-dsp
 	url = https://github.com/espressif/esp-dsp
-[submodule "external/csv2"]
+[submodule "components/csv/detail/csv2"]
 	path = components/csv/detail/csv2
 	url = https://github.com/p-ranav/csv2
-[submodule "external/cli"]
+[submodule "components/cli/detail/cli"]
 	path = components/cli/detail/cli
 	url = https://github.com/daniele77/cli
-[submodule "external/tabulate"]
+[submodule "components/tabulate/detail/tabulate"]
 	path = components/tabulate/detail/tabulate
 	url = https://github.com/p-ranav/tabulate
 [submodule "lib/pybind11"]
 	path = lib/pybind11
 	url = https://github.com/pybind/pybind11
-[submodule "external/magic_enum"]
+[submodule "components/state_machine/detail/magic_enum"]
 	path = components/state_machine/detail/magic_enum
 	url = https://github.com/neargye/magic_enum
 [submodule "components/esp-nimble-cpp"]
 	path = components/esp-nimble-cpp
 	url = https://github.com/esp-cpp/esp-nimble-cpp
-[submodule "external/hid-rp"]
+[submodule "components/hid-rp/detail/hid-rp"]
 	path = components/hid-rp/detail/hid-rp
 	url = https://github.com/intergatedcircuits/hid-rp
-[submodule "external/nearby"]
+[submodule "components/gfps_service/detail/nearby"]
 	path = components/gfps_service/detail/nearby
 	url = https://github.com/google/nearby
 [submodule "components/binary-log/detail"]

components/ads7138/include/ads7138.hpp

@@ -1400,7 +1400,7 @@ class Ads7138 : public BasePeripheral<> {
   }
 
   /// @brief Configure an alert events for an analog channel.
-  /// @param channel Channel to configure.
+  /// @param ch Channel to configure.
   /// @param low_threshold_mv Low threshold in mV.
   /// @param high_threshold_mv High threshold in mV.
   /// @param event_count Number of events to trigger an alert.

components/bldc_haptics/include/detent_config.hpp

@@ -1,5 +1,3 @@
-/// @file Defines the detent configuration
-
 #pragma once
 
 #include "format.hpp"

components/ble_gatt_server/include/ble_gatt_server_menu.hpp

@@ -21,12 +21,12 @@ namespace espp {
 /// the paired devices, viewing the connected devices, disconnecting devices,
 /// and more.
 ///
-/// \section Example
+/// \section ble_gatt_server_menu_ex1 Example
 /// \snippet ble_gatt_server_example.cpp ble gatt server example
 class BleGattServerMenu {
 public:
-  /// @brief Construct a new I2cMenu object.
-  /// @param i2c A reference to the I2c bus to interact with.
+  /// @brief Construct a new BleGattServerMenu.
+  /// @param server The BleGattServer to use.
   explicit BleGattServerMenu(std::reference_wrapper<espp::BleGattServer> server)
       : server_(server) {}
 

components/bm8563/include/bm8563.hpp

@@ -8,7 +8,7 @@ namespace espp {
 /// @brief The BM8563 RTC driver.
 /// @details This driver is for the BM8563 RTC chip.
 ///
-/// \section Example
+/// \section bm8563_ex1 Example
 /// \snippet bm8563_example.cpp bm8563 example
 class Bm8563 : public BasePeripheral<> {
 public:
@@ -21,19 +21,56 @@ class Bm8563 : public BasePeripheral<> {
     uint8_t month;   ///< The month.
     uint8_t weekday; ///< The day of the week.
     uint8_t day;     ///< The day of the month.
+
+    /// @brief Equality operator.
+    /// @param other The other date.
+    /// @return True if equal, false otherwise.
+    bool operator==(const Date &other) const {
+      return year == other.year && month == other.month && weekday == other.weekday &&
+             day == other.day;
+    }
+
+    /// @brief Inequality operator.
+    /// @param other The other date.
+    /// @return True if not equal, false otherwise.
+    bool operator!=(const Date &other) const { return !(*this == other); }
   };
 
   /// @brief The time structure.
   struct Time {
     uint8_t hour;   ///< The hour.
     uint8_t minute; ///< The minute.
     uint8_t second; ///< The second.
+
+    /// @brief Equality operator.
+    /// @param other The other time.
+    /// @return True if equal, false otherwise.
+    bool operator==(const Time &other) const {
+      return hour == other.hour && minute == other.minute && second == other.second;
+    }
+
+    /// @brief Inequality operator.
+    /// @param other The other time.
+    /// @return True if not equal, false otherwise.
+    bool operator!=(const Time &other) const { return !(*this == other); }
   };
 
   /// @brief The date and time structure.
   struct DateTime {
     Date date; ///< The date.
     Time time; ///< The time.
+
+    /// @brief Equality operator.
+    /// @param other The other date and time.
+    /// @return True if equal, false otherwise.
+    bool operator==(const DateTime &other) const {
+      return date == other.date && time == other.time;
+    }
+
+    /// @brief Inequality operator.
+    /// @param other The other date and time.
+    /// @return True if not equal, false otherwise.
+    bool operator!=(const DateTime &other) const { return !(*this == other); }
   };
 
   /// @brief The configuration structure.
@@ -180,32 +217,6 @@ class Bm8563 : public BasePeripheral<> {
 };
 } // namespace espp
 
-/// @brief Compare two Date objects.
-/// @param lhs The left hand side.
-/// @param rhs The right hand side.
-/// @return True if the objects are equal.
-[[maybe_unused]] static bool operator==(const espp::Bm8563::Date &lhs,
-                                        const espp::Bm8563::Date &rhs) {
-  return lhs.year == rhs.year && lhs.month == rhs.month && lhs.weekday == rhs.weekday &&
-         lhs.day == rhs.day;
-}
-
-/// @brief Compare two Time objects.
-/// @param lhs The left hand side.
-/// @param rhs The right hand side.
-[[maybe_unused]] static bool operator==(const espp::Bm8563::Time &lhs,
-                                        const espp::Bm8563::Time &rhs) {
-  return lhs.hour == rhs.hour && lhs.minute == rhs.minute && lhs.second == rhs.second;
-}
-
-/// @brief Compare two DateTime objects.
-/// @param lhs The left hand side.
-/// @param rhs The right hand side.
-/// @return True if the objects are equal.
-[[maybe_unused]] static bool operator==(const espp::Bm8563::DateTime &lhs,
-                                        const espp::Bm8563::DateTime &rhs) {
-  return lhs.date == rhs.date && lhs.time == rhs.time;
-}
 // for allowing easy serialization/printing of the
 // espp::Bm8563::Date, espp::Bm8563::Time, and espp::Bm8563::DateTime
 template <> struct fmt::formatter<espp::Bm8563::Date> {

components/chsc6x/include/chsc6x.hpp

@@ -8,7 +8,7 @@
 namespace espp {
 /// @brief Driver for the Chsc6x touch controller
 ///
-/// \section Example
+/// \section chsc6x_ex1 Example
 /// \snippet chsc6x_example.cpp chsc6x example
 class Chsc6x : public BasePeripheral<> {
 public:

components/cst816/include/cst816.hpp

@@ -16,7 +16,7 @@ namespace espp {
 /// here:
 /// https://github.com/espressif/esp-bsp/tree/master/components/lcd_touch/esp_lcd_touch_cst816s
 ///
-/// \section Example
+/// \section cst816_ex1 Example
 /// \snippet cst816_example.cpp cst816 example
 class Cst816 : public BasePeripheral<std::uint8_t> {
 public:

components/display_drivers/include/gc9a01.hpp

@@ -238,7 +238,7 @@ class Gc9a01 {
 
   /**
    * @brief Flush the pixel data for the provided area to the display.
-   * @param *drv Pointer to the LVGL display driver.
+   * @param *disp Pointer to the LVGL display.
    * @param *area Pointer to the structure describing the pixel area.
    * @param *color_map Pointer to array of colors to flush to the display.
    */
@@ -292,10 +292,10 @@ class Gc9a01 {
   }
 
   /**
-   * @brief Flush the pixel data for the provided area to the display.
-   * @param *drv Pointer to the LVGL display driver.
+   * @brief Fill the display area with the provided color map.
+   * @param *disp Pointer to the LVGL display.
    * @param *area Pointer to the structure describing the pixel area.
-   * @param *color_map Pointer to array of colors to flush to the display.
+   * @param *color_map Pointer to array of colors to fill the display with.
    * @param flags uint32_t user data / flags to pass to the lcd_write transfer function.
    */
   static void fill(lv_display_t *disp, const lv_area_t *area, uint8_t *color_map,

components/display_drivers/include/ili9341.hpp

@@ -168,7 +168,7 @@ class Ili9341 {
 
   /**
    * @brief Flush the pixel data for the provided area to the display.
-   * @param *drv Pointer to the LVGL display driver.
+   * @param *disp Pointer to the LVGL display.
    * @param *area Pointer to the structure describing the pixel area.
    * @param *color_map Pointer to array of colors to flush to the display.
    */
@@ -222,8 +222,8 @@ class Ili9341 {
   }
 
   /**
-   * @brief Flush the pixel data for the provided area to the display.
-   * @param *drv Pointer to the LVGL display driver.
+   * @brief Fill the display area with the provided color map.
+   * @param *disp Pointer to the LVGL display.
    * @param *area Pointer to the structure describing the pixel area.
    * @param *color_map Pointer to array of colors to flush to the display.
    * @param flags uint32_t user data / flags to pass to the lcd_write transfer function.

components/display_drivers/include/sh8601.hpp

@@ -182,7 +182,7 @@ class Sh8601 {
 
   /**
    * @brief Flush the pixel data for the provided area to the display.
-   * @param *drv Pointer to the LVGL display driver.
+   * @param *disp Pointer to the LVGL display.
    * @param *area Pointer to the structure describing the pixel area.
    * @param *color_map Pointer to array of colors to flush to the display.
    */