EMTime/libopencm3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

stm32: crs: fix doxygen

Browse Source 
We need per device header includes to make the per target documentation
generation work properly.  The dispatch headers are to dispatch to the
_target_ not directly to the final implementation, remember, the final
required headers for each may be multiple files, plus extra definitions!
This commit is contained in:
Karl Palsson
2020-12-01 23:13:38 +00:00
parent 98855377c6
commit f82053000c
7 changed files with 59 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/libopencm3/stm32/common/crs_common_all.h
View File

@@ -1,10 +1,4 @@
/** @defgroup CRS_defines CRS Defines /** @addtogroup crs_defines
*
* @brief <b>STM32 Clock Recovery System: Defined Constants and Types</b>
*
* @ingroup STM32_defines
*
* @version 1.0.0
* *
* @date 5 Feb 2014 * @date 5 Feb 2014
* *

8
include/libopencm3/stm32/crs.h
View File

@@ -21,13 +21,13 @@
#include <libopencm3/stm32/memorymap.h> #include <libopencm3/stm32/memorymap.h>
#if defined(STM32F0) #if defined(STM32F0)
# include <libopencm3/stm32/common/crs_common_all.h> # include <libopencm3/stm32/f0/crs.h>
#elif defined(STM32L0) #elif defined(STM32L0)
# include <libopencm3/stm32/common/crs_common_all.h> # include <libopencm3/stm32/l0/crs.h>
#elif defined(STM32L4) #elif defined(STM32L4)
# include <libopencm3/stm32/common/crs_common_all.h> # include <libopencm3/stm32/l4/crs.h>
#elif defined(STM32G4) #elif defined(STM32G4)
# include <libopencm3/stm32/common/crs_common_all.h> # include <libopencm3/stm32/g4/crs.h>
#else #else
# error "stm32 family not defined or not supported for this peripheral" # error "stm32 family not defined or not supported for this peripheral"
#endif #endif

12
include/libopencm3/stm32/f0/crs.h Normal file
View File

@@ -0,0 +1,12 @@
/** @defgroup crs_defines CRS Defines
*
* @brief <b>Defined Constants and Types for the Clock Recovery System.</b>
*
* @ingroup STM32F0xx_defines
*
*LGPL License Terms @ref lgpl_license
*/
#pragma once
#include <libopencm3/stm32/common/crs_common_all.h>

12
include/libopencm3/stm32/g4/crs.h Normal file
View File

@@ -0,0 +1,12 @@
/** @defgroup crs_defines CRS Defines
*
* @brief <b>Defined Constants and Types for the Clock Recovery System.</b>
*
* @ingroup STM32G4xx_defines
*
*LGPL License Terms @ref lgpl_license
*/
#pragma once
#include <libopencm3/stm32/common/crs_common_all.h>

12
include/libopencm3/stm32/l0/crs.h Normal file
View File

@@ -0,0 +1,12 @@
/** @defgroup crs_defines CRS Defines
*
* @brief <b>Defined Constants and Types for the Clock Recovery System.</b>
*
* @ingroup STM32L0xx_defines
*
*LGPL License Terms @ref lgpl_license
*/
#pragma once
#include <libopencm3/stm32/common/crs_common_all.h>

12
include/libopencm3/stm32/l4/crs.h Normal file
View File

@@ -0,0 +1,12 @@
/** @defgroup crs_defines CRS Defines
*
* @brief <b>Defined Constants and Types for the Clock Recovery System.</b>
*
* @ingroup STM32L4xx_defines
*
*LGPL License Terms @ref lgpl_license
*/
#pragma once
#include <libopencm3/stm32/common/crs_common_all.h>

10
lib/stm32/common/crs_common_all.c
View File

@@ -1,8 +1,7 @@
/** @defgroup crs_file CRS /** @addtogroup crs_file CRS peripheral API
* @ingroup peripheral_apis
* *
* @ingroup STM32xx * @brief <b>(USB) STM32 Clock Recovery Subsystem</b>
*
* @brief <b>libopencm3 STM32 Clock Recovery Subsystem</b>
* *
* @version 1.0.0 * @version 1.0.0
* *
@@ -27,6 +26,8 @@
* You should have received a copy of the GNU Lesser General Public License * You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>. * along with this library. If not, see <http://www.gnu.org/licenses/>.
*/ */
/**@{*/
#include <libopencm3/stm32/crs.h> #include <libopencm3/stm32/crs.h>
#include <libopencm3/stm32/rcc.h> #include <libopencm3/stm32/rcc.h>
@@ -46,3 +47,4 @@ void crs_autotrim_usb_enable(void)
CRS_CR |= CRS_CR_CEN; CRS_CR |= CRS_CR_CEN;
} }
/**@}*/