doc: use common naming for peripheral apis
Only applied to STM32 doc trees at present. Instead of declaring a group for "STM32blah" in the doc-blah.h files, and then trying to put all the common+specific peripheral code into those groups, (which is what led to the stub doxygen holder empty .c files) Just use a standard name like "Peripheral APIS" and place everything into that. Demonstrated by converting ADC and USART peripherals, which is definitely not complete, but it shows how to make things less magical, and less prone to copy/paste errors. Now, you can copy/paste and it will do the right thing, because everyone uses the same group names. This is also how to unify the mix of "STM32blah->Periphblah" and _also_ the dangling "periph_file" modules in doxygen, it merges them together properly, as they're intended to be really.
This commit is contained in:
@@ -9,6 +9,10 @@
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup peripheral_apis Peripheral APIs
|
||||
* APIs for device peripherals
|
||||
*/
|
||||
|
||||
/** @defgroup STM32F0xx STM32F0xx
|
||||
* Libraries for ST Microelectronics STM32F0xx series.
|
||||
*
|
||||
|
||||
@@ -9,6 +9,10 @@ API documentation for ST Microelectronics STM32F1 Cortex M3 series.
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup peripheral_apis Peripheral APIs
|
||||
* APIs for device peripherals
|
||||
*/
|
||||
|
||||
/** @defgroup STM32F1xx STM32F1xx
|
||||
Libraries for ST Microelectronics STM32F1xx series.
|
||||
|
||||
|
||||
@@ -10,6 +10,10 @@ LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
|
||||
/** @defgroup peripheral_apis Peripheral APIs
|
||||
* APIs for device peripherals
|
||||
*/
|
||||
|
||||
/** @defgroup STM32F2xx STM32F2xx
|
||||
Libraries for ST Microelectronics STM32F2xx series.
|
||||
|
||||
|
||||
@@ -9,6 +9,10 @@
|
||||
* LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup peripheral_apis Peripheral APIs
|
||||
* APIs for device peripherals
|
||||
*/
|
||||
|
||||
/** @defgroup STM32F3xx STM32F3xx
|
||||
* Libraries for ST Microelectronics STM32F3xx series.
|
||||
*
|
||||
|
||||
@@ -9,6 +9,10 @@ API documentation for ST Microelectronics STM32F4 Cortex M3 series.
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup peripheral_apis Peripheral APIs
|
||||
* APIs for device peripherals
|
||||
*/
|
||||
|
||||
/** @defgroup STM32F4xx STM32F4xx
|
||||
Libraries for ST Microelectronics STM32F4xx series.
|
||||
|
||||
|
||||
@@ -9,6 +9,10 @@ API documentation for ST Microelectronics STM32F7 Cortex M7 series.
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup peripheral_apis Peripheral APIs
|
||||
* APIs for device peripherals
|
||||
*/
|
||||
|
||||
/** @defgroup STM32F7xx STM32F7xx
|
||||
Libraries for ST Microelectronics STM32F7xx series.
|
||||
|
||||
|
||||
@@ -9,6 +9,10 @@ API documentation for ST Microelectronics STM32L0 Cortex M0 series.
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup peripheral_apis Peripheral APIs
|
||||
* APIs for device peripherals
|
||||
*/
|
||||
|
||||
/** @defgroup STM32L0xx STM32L0xx
|
||||
Libraries for ST Microelectronics STM32L0xx series.
|
||||
|
||||
|
||||
@@ -9,6 +9,10 @@ API documentation for ST Microelectronics STM32L1 Cortex M3 series.
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup peripheral_apis Peripheral APIs
|
||||
* APIs for device peripherals
|
||||
*/
|
||||
|
||||
/** @defgroup STM32L1xx STM32L1xx
|
||||
Libraries for ST Microelectronics STM32L1xx series.
|
||||
|
||||
|
||||
@@ -9,6 +9,10 @@ API documentation for ST Microelectronics STM32L4 Cortex M4 series.
|
||||
LGPL License Terms @ref lgpl_license
|
||||
*/
|
||||
|
||||
/** @defgroup peripheral_apis Peripheral APIs
|
||||
* APIs for device peripherals
|
||||
*/
|
||||
|
||||
/** @defgroup STM32L4xx STM32L4xx
|
||||
Libraries for ST Microelectronics STM32L4xx series.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user