docs: create a new file for gathering groups

Signed-off-by: Gerard Marull-Paretas <[email protected]>
teslabs · Jan 2, 2022 · 222b327 · 222b327
1 parent bbeaaef
commit 222b327
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 19 deletions.
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
@@ -1,7 +1,7 @@
 PROJECT_NAME = "Spinner"
 PROJECT_BRIEF = "FOC Motor Control Firmware"
 PROJECT_LOGO = @SPINNER_BASE@/docs/_static/images/logo.png
-INPUT = @SPINNER_BASE@/docs/doxygen.md @SPINNER_BASE@/include
+INPUT = @SPINNER_BASE@/docs/_doxygen/groups.dox @SPINNER_BASE@/docs/doxygen.md @SPINNER_BASE@/include
 EXCLUDE = @SPINNER_BASE@/include/dts-bindings
 OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_DIRECTORY@
 STRIP_FROM_PATH = @SPINNER_BASE@/include

diff --git a/docs/_doxygen/groups.dox b/docs/_doxygen/groups.dox
@@ -0,0 +1,19 @@
+/**
+ * @defgroup spinner_drivers Driver APIs
+ * @{
+ * @}
+ */
+
+/**
+ * @defgroup spinner_lib_control Control APIs
+ * @{
+ * @}
+ */
+
+/**
+ * @defgroup spinner_lib_utils Utility APIs
+ * @{
+ * @}
+ */
+
+
diff --git a/include/spinner/control/cloop.h b/include/spinner/control/cloop.h
@@ -10,12 +10,6 @@
 #ifndef _SPINNER_LIB_CONTROL_CLOOP_H_
 #define _SPINNER_LIB_CONTROL_CLOOP_H_
 
-/**
- * @defgroup spinner_lib_control Control APIs
- * @{
- * @}
- */
-
 /**
  * @defgroup spinner_lib_control_cloop Current Loop API
  * @ingroup spinner_lib_control

diff --git a/include/spinner/drivers/currsmp.h b/include/spinner/drivers/currsmp.h
@@ -13,12 +13,6 @@
 #include <device.h>
 #include <zephyr/types.h>
 
-/**
- * @defgroup spinner_drivers Driver APIs
- * @{
- * @}
- */
-
 /**
  * @defgroup spinner_drivers_currsmp Current Sampling API
  * @ingroup spinner_drivers

diff --git a/include/spinner/utils/stm32_adc.h b/include/spinner/utils/stm32_adc.h
@@ -14,12 +14,6 @@
 
 #include <stm32_ll_adc.h>
 
-/**
- * @defgroup spinner_lib_utils Utility APIs
- * @{
- * @}
- */
-
 /**
  * @defgroup spinner_utils_stm32_adc STM32 ADC Utilities
  * @ingroup spinner_lib_utils