Doxygen + Documentation Maintenance

.github/workflows/docs.yml

@@ -9,7 +9,7 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Fetch Repository Reference Info
         id: repo-info
         run: |
@@ -26,15 +26,15 @@ jobs:
 
       - name: Install Doxygen
         env: 
-          DOXYGEN_VERSION: 1.9.7
+          DOXYGEN_VERSION: 1.11.0
         run: |
           wget -q https://www.doxygen.nl/files/doxygen-${{ env.DOXYGEN_VERSION }}.linux.bin.tar.gz
           tar -xf doxygen-${{ env.DOXYGEN_VERSION }}.linux.bin.tar.gz
           cd doxygen-${{ env.DOXYGEN_VERSION }} && sudo make install
 
       - name: Install Themes
         env:
-          DOXYGEN_AWESOME_VERSION: 2.2.0
+          DOXYGEN_AWESOME_VERSION: 2.3.3
         working-directory: ./docs
         run: |
           git clone --depth 1 -b v${{ env.DOXYGEN_AWESOME_VERSION }} https://github.com/jothepro/doxygen-awesome-css
@@ -46,7 +46,7 @@ jobs:
           doxygen Doxyfile
 
       - name: Deploy Docs
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_branch: gh-pages

docs/DoxygenLayout.xml

@@ -1,10 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
 <doxygenlayout version="1.0">
-  <!-- Generated by doxygen 1.9.3 -->
+  <!-- Generated by doxygen 1.11.0 -->
   <!-- Navigation index tabs for HTML output -->
   <navindex>
     <tab type="mainpage" visible="yes" title=""/>
     <tab type="pages" visible="yes" title="" intro=""/>
-    <tab type="modules" visible="yes" title="" intro=""/>
+    <tab type="topics" visible="yes" title="" intro=""/>
+    <tab type="modules" visible="yes" title="" intro="">
+      <tab type="modulelist" visible="yes" title="" intro=""/>
+      <tab type="modulemembers" visible="yes" title="" intro=""/>
+    </tab>
     <tab type="namespaces" visible="yes" title="">
       <tab type="namespacelist" visible="yes" title="" intro=""/>
       <tab type="namespacemembers" visible="yes" title="" intro=""/>
@@ -13,37 +18,37 @@
     </tab>
     <tab type="interfaces" visible="yes" title="">
       <tab type="interfacelist" visible="yes" title="" intro=""/>
-      <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/> 
+      <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
       <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
     </tab>
     <tab type="classes" visible="yes" title="">
       <tab type="classlist" visible="yes" title="" intro=""/>
-      <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
+      <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
       <tab type="hierarchy" visible="yes" title="" intro=""/>
       <tab type="classmembers" visible="yes" title="" intro=""/>
     </tab>
     <tab type="structs" visible="yes" title="">
       <tab type="structlist" visible="yes" title="" intro=""/>
-      <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/> 
+      <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
     </tab>
     <tab type="exceptions" visible="yes" title="">
       <tab type="exceptionlist" visible="yes" title="" intro=""/>
-      <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/> 
+      <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
       <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
     </tab>
     <tab type="files" visible="yes" title="">
       <tab type="filelist" visible="yes" title="" intro=""/>
       <tab type="globals" visible="yes" title="" intro=""/>
     </tab>
-    <tab type="examples" visible="yes" title="" intro=""/>  
+    <tab type="examples" visible="yes" title="" intro=""/>
   </navindex>
 
   <!-- Layout definition for a class page -->
   <class>
     <detaileddescription title=""/>
     <includes visible="$SHOW_HEADERFILE"/>
-    <inheritancegraph visible="$CLASS_GRAPH"/>
-    <collaborationgraph visible="$COLLABORATION_GRAPH"/>
+    <inheritancegraph visible="yes"/>
+    <collaborationgraph visible="yes"/>
     <memberdecl>
       <nestedclasses visible="yes" title=""/>
       <publictypes title=""/>
@@ -113,6 +118,7 @@
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
       <membergroups visible="yes"/>
     </memberdecl>
     <memberdef>
@@ -123,6 +129,7 @@
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
     </memberdef>
     <authorsection visible="yes"/>
   </namespace>
@@ -139,8 +146,8 @@
   <file>
     <detaileddescription title=""/>
     <includes visible="$SHOW_INCLUDE_FILES"/>
-    <includegraph visible="$INCLUDE_GRAPH"/>
-    <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
+    <includegraph visible="yes"/>
+    <includedbygraph visible="yes"/>
     <sourcelink visible="yes"/>
     <memberdecl>
       <interfaces visible="yes" title=""/>
@@ -157,6 +164,7 @@
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
       <membergroups visible="yes"/>
     </memberdecl>
     <memberdef>
@@ -168,16 +176,18 @@
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
     </memberdef>
     <authorsection/>
   </file>
 
   <!-- Layout definition for a group page -->
   <group>
     <detaileddescription title=""/>
-    <groupgraph visible="$GROUP_GRAPHS"/>
+    <groupgraph visible="yes"/>
     <memberdecl>
       <nestedgroups visible="yes" title=""/>
+      <modules visible="yes" title=""/>
       <dirs visible="yes" title=""/>
       <files visible="yes" title=""/>
       <namespaces visible="yes" title=""/>
@@ -222,6 +232,25 @@
     <authorsection visible="yes"/>
   </group>
 
+  <!-- Layout definition for a C++20 module page -->
+  <module>
+    <briefdescription visible="yes"/>
+    <exportedmodules visible="yes"/>
+    <memberdecl>
+      <concepts visible="yes" title=""/>
+      <classes visible="yes" title=""/>
+      <enums title=""/>
+      <typedefs title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <membergroups title=""/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdecl>
+      <files visible="yes"/>
+    </memberdecl>
+  </module>
+
   <!-- Layout definition for a directory page -->
   <directory>
     <briefdescription visible="yes"/>

src/FastLED.h

@@ -124,33 +124,142 @@ template<uint8_t DATA_PIN, EOrder RGB_ORDER> class PIXIE : public PixieControlle
 /// LED controller for WS2812 LEDs with GRB color order
 /// @see WS2812Controller800Khz
 template<uint8_t DATA_PIN> class NEOPIXEL : public WS2812Controller800Khz<DATA_PIN, GRB> {};
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class SM16703 : public SM16703Controller<DATA_PIN, RGB_ORDER> {};                   ///< @copydoc SM16703Controller
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class TM1829 : public TM1829Controller800Khz<DATA_PIN, RGB_ORDER> {};               ///< @copydoc TM1829Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class TM1812 : public TM1809Controller800Khz<DATA_PIN, RGB_ORDER> {};               ///< TM1812 controller class. @copydetails TM1809Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class TM1809 : public TM1809Controller800Khz<DATA_PIN, RGB_ORDER> {};               ///< @copydoc TM1809Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class TM1804 : public TM1809Controller800Khz<DATA_PIN, RGB_ORDER> {};               ///< TM1804 controller class. @copydetails TM1809Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class TM1803 : public TM1803Controller400Khz<DATA_PIN, RGB_ORDER> {};               ///< @copydoc TM1803Controller400Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class UCS1903 : public UCS1903Controller400Khz<DATA_PIN, RGB_ORDER> {};             ///< @copydoc UCS1903Controller400Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class UCS1903B : public UCS1903BController800Khz<DATA_PIN, RGB_ORDER> {};           ///< @copydoc UCS1903BController800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class UCS1904 : public UCS1904Controller800Khz<DATA_PIN, RGB_ORDER> {};             ///< @copydoc UCS1904Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class UCS2903 : public UCS2903Controller<DATA_PIN, RGB_ORDER> {};                   ///< @copydoc UCS2903Controller
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class WS2812 : public WS2812Controller800Khz<DATA_PIN, RGB_ORDER> {};               ///< @copydoc WS2812Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class WS2852 : public WS2812Controller800Khz<DATA_PIN, RGB_ORDER> {};               ///< WS2852 controller class. @copydetails WS2812Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class WS2812B : public WS2812Controller800Khz<DATA_PIN, RGB_ORDER> {};              ///< WS2812B controller class. @copydetails WS2812Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class GS1903 : public WS2812Controller800Khz<DATA_PIN, RGB_ORDER> {};               ///< GS1903 controller class. @copydetails WS2812Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class SK6812 : public SK6812Controller<DATA_PIN, RGB_ORDER> {};                     ///< @copydoc SK6812Controller
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class SK6822 : public SK6822Controller<DATA_PIN, RGB_ORDER> {};                     ///< SK6822 controller class. @copydetails SK6822Controller
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class APA106 : public SK6822Controller<DATA_PIN, RGB_ORDER> {};                     ///< APA106 controller class. @copydetails SK6822Controller
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class PL9823 : public PL9823Controller<DATA_PIN, RGB_ORDER> {};                     ///< @copydoc PL9823Controller
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class WS2811 : public WS2811Controller800Khz<DATA_PIN, RGB_ORDER> {};               ///< @copydoc WS2811Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class WS2813 : public WS2813Controller<DATA_PIN, RGB_ORDER> {};                     ///< @copydoc WS2813Controller
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class APA104 : public WS2811Controller800Khz<DATA_PIN, RGB_ORDER> {};               ///< APA104 controller class. @copydetails WS2811Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class WS2811_400 : public WS2811Controller400Khz<DATA_PIN, RGB_ORDER> {};           ///< @copydoc WS2811Controller400Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class GE8822 : public GE8822Controller800Khz<DATA_PIN, RGB_ORDER> {};               ///< @copydoc GE8822Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class GW6205 : public GW6205Controller800Khz<DATA_PIN, RGB_ORDER> {};               ///< @copydoc GW6205Controller800Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class GW6205_400 : public GW6205Controller400Khz<DATA_PIN, RGB_ORDER> {};           ///< @copydoc GW6205Controller400Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class LPD1886 : public LPD1886Controller1250Khz<DATA_PIN, RGB_ORDER> {};            ///< @copydoc LPD1886Controller1250Khz
-template<uint8_t DATA_PIN, EOrder RGB_ORDER> class LPD1886_8BIT : public LPD1886Controller1250Khz_8bit<DATA_PIN, RGB_ORDER> {};  ///< @copydoc LPD1886Controller1250Khz_8bit
+
+/// @brief SM16703 controller class.
+/// @copydetails SM16703Controller
+template<uint8_t DATA_PIN, EOrder RGB_ORDER> 
+class SM16703 : public SM16703Controller<DATA_PIN, RGB_ORDER> {};
+
+/// @brief TM1829 controller class.
+/// @copydetails TM1829Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class TM1829 : public TM1829Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief TM1812 controller class.
+/// @copydetails TM1809Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class TM1812 : public TM1809Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief TM1809 controller class.
+/// @copydetails TM1809Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class TM1809 : public TM1809Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief TM1804 controller class.
+/// @copydetails TM1809Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class TM1804 : public TM1809Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief TM1803 controller class.
+/// @copydetails TM1803Controller400Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class TM1803 : public TM1803Controller400Khz<DATA_PIN, RGB_ORDER> {}; 
+
+/// @brief UCS1903 controller class.
+/// @copydetails UCS1903Controller400Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class UCS1903 : public UCS1903Controller400Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief UCS1903B controller class.
+/// @copydetails UCS1903BController800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class UCS1903B : public UCS1903BController800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief UCS1904 controller class.
+/// @copydetails UCS1904Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class UCS1904 : public UCS1904Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief UCS2903 controller class.
+/// @copydetails UCS2903Controller
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class UCS2903 : public UCS2903Controller<DATA_PIN, RGB_ORDER> {};
+
+/// @brief WS2812 controller class.
+/// @copydetails WS2812Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class WS2812 : public WS2812Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief WS2852 controller class.
+/// @copydetails WS2812Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class WS2852 : public WS2812Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief WS2812B controller class.
+/// @copydetails WS2812Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class WS2812B : public WS2812Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief GS1903 controller class.
+/// @copydetails WS2812Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class GS1903 : public WS2812Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief SK6812 controller class.
+/// @copydetails SK6812Controller
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class SK6812 : public SK6812Controller<DATA_PIN, RGB_ORDER> {};
+
+/// @brief SK6822 controller class.
+/// @copydetails SK6822Controller
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class SK6822 : public SK6822Controller<DATA_PIN, RGB_ORDER> {};
+
+/// @brief APA106 controller class.
+/// @copydetails SK6822Controller
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class APA106 : public SK6822Controller<DATA_PIN, RGB_ORDER> {};
+
+/// @brief PL9823 controller class.
+/// @copydetails PL9823Controller
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class PL9823 : public PL9823Controller<DATA_PIN, RGB_ORDER> {};
+
+/// @brief WS2811 controller class.
+/// @copydetails WS2811Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class WS2811 : public WS2811Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief WS2813 controller class.
+/// @copydetails WS2813Controller
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class WS2813 : public WS2813Controller<DATA_PIN, RGB_ORDER> {};
+
+/// @brief APA104 controller class.
+/// @copydetails WS2811Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class APA104 : public WS2811Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief WS2811_400 controller class.
+/// @copydetails WS2811Controller400Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class WS2811_400 : public WS2811Controller400Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief GE8822 controller class.
+/// @copydetails GE8822Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class GE8822 : public GE8822Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief GW6205 controller class.
+/// @copydetails GW6205Controller800Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class GW6205 : public GW6205Controller800Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief GW6205_400 controller class.
+/// @copydetails GW6205Controller400Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class GW6205_400 : public GW6205Controller400Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief LPD1886 controller class.
+/// @copydetails LPD1886Controller1250Khz
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class LPD1886 : public LPD1886Controller1250Khz<DATA_PIN, RGB_ORDER> {};
+
+/// @brief LPD1886_8BIT controller class.
+/// @copydetails LPD1886Controller1250Khz_8bit
+template<uint8_t DATA_PIN, EOrder RGB_ORDER>
+class LPD1886_8BIT : public LPD1886Controller1250Khz_8bit<DATA_PIN, RGB_ORDER> {};
+
 #if defined(DmxSimple_h) || defined(FASTLED_DOXYGEN)
 /// @copydoc DMXSimpleController
 template<uint8_t DATA_PIN, EOrder RGB_ORDER> class DMXSIMPLE : public DMXSimpleController<DATA_PIN, RGB_ORDER> {};

src/chipsets.h

@@ -363,6 +363,11 @@ class APA102Controller : public CPixelLEDController<RGB_ORDER> {
 	}
 };
 
+/// APA102 high definition controller class.
+/// @tparam DATA_PIN the data pin for these LEDs
+/// @tparam CLOCK_PIN the clock pin for these LEDs
+/// @tparam RGB_ORDER the RGB ordering for these LEDs
+/// @tparam SPI_SPEED the clock divider used for these LEDs.  Set using the ::DATA_RATE_MHZ / ::DATA_RATE_KHZ macros.  Defaults to ::DATA_RATE_MHZ(24)
 template <
 	uint8_t DATA_PIN,
 	uint8_t CLOCK_PIN,

src/cpp_compat.h

@@ -21,6 +21,10 @@
 // things that we can turn on if we're in a C++11 environment
 #endif
 
+/// @def FASTLED_REGISTER
+/// Helper macro to replace the deprecated 'register' keyword if we're
+/// using modern C++ where it's been removed entirely.
+
 #if __cplusplus < 201703L
 #define FASTLED_REGISTER register
 #else

src/fastled_progmem.h

@@ -24,7 +24,6 @@ FASTLED_NAMESPACE_BEGIN
 // included without a defined platform
 #ifdef FASTLED_DOXYGEN
 #define FASTLED_USE_PROGMEM 1
-#define FL_ALIGN_PROGMEM  __attribute__ ((aligned (4)))
 #endif
 
 /// @def FASTLED_USE_PROGMEM
@@ -33,7 +32,7 @@ FASTLED_NAMESPACE_BEGIN
 /// and the FL_PGM_* accessors to the Arduino equivalents.
 
 
-#if FASTLED_USE_PROGMEM == 1
+#if (FASTLED_USE_PROGMEM == 1) || defined(FASTLED_DOXYGEN)
 #ifndef FASTLED_INCLUDE_PGMSPACE
 #define FASTLED_INCLUDE_PGMSPACE 1
 #endif
@@ -96,7 +95,7 @@ FASTLED_NAMESPACE_BEGIN
 /// palette code uses 'read dword', and now uses this macro
 /// to make sure that gradient palettes are 4-byte aligned.
 
-#if defined(FASTLED_ARM) || defined(ESP32) || defined(ESP8266)
+#if defined(FASTLED_ARM) || defined(ESP32) || defined(ESP8266) || defined(FASTLED_DOXYGEN)
 #define FL_ALIGN_PROGMEM  __attribute__ ((aligned (4)))
 #else
 #define FL_ALIGN_PROGMEM