stm32: crs: fix doxygen
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:
@@ -1,10 +1,4 @@
|
||||
/** @defgroup CRS_defines CRS Defines
|
||||
*
|
||||
* @brief <b>STM32 Clock Recovery System: Defined Constants and Types</b>
|
||||
*
|
||||
* @ingroup STM32_defines
|
||||
*
|
||||
* @version 1.0.0
|
||||
/** @addtogroup crs_defines
|
||||
*
|
||||
* @date 5 Feb 2014
|
||||
*
|
||||
|
||||
@@ -21,13 +21,13 @@
|
||||
#include <libopencm3/stm32/memorymap.h>
|
||||
|
||||
#if defined(STM32F0)
|
||||
# include <libopencm3/stm32/common/crs_common_all.h>
|
||||
# include <libopencm3/stm32/f0/crs.h>
|
||||
#elif defined(STM32L0)
|
||||
# include <libopencm3/stm32/common/crs_common_all.h>
|
||||
# include <libopencm3/stm32/l0/crs.h>
|
||||
#elif defined(STM32L4)
|
||||
# include <libopencm3/stm32/common/crs_common_all.h>
|
||||
# include <libopencm3/stm32/l4/crs.h>
|
||||
#elif defined(STM32G4)
|
||||
# include <libopencm3/stm32/common/crs_common_all.h>
|
||||
# include <libopencm3/stm32/g4/crs.h>
|
||||
#else
|
||||
# error "stm32 family not defined or not supported for this peripheral"
|
||||
#endif
|
||||
|
||||
12
include/libopencm3/stm32/f0/crs.h
Normal file
12
include/libopencm3/stm32/f0/crs.h
Normal 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
12
include/libopencm3/stm32/g4/crs.h
Normal 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
12
include/libopencm3/stm32/l0/crs.h
Normal 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
12
include/libopencm3/stm32/l4/crs.h
Normal 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>
|
||||
@@ -1,8 +1,7 @@
|
||||
/** @defgroup crs_file CRS
|
||||
/** @addtogroup crs_file CRS peripheral API
|
||||
* @ingroup peripheral_apis
|
||||
*
|
||||
* @ingroup STM32xx
|
||||
*
|
||||
* @brief <b>libopencm3 STM32 Clock Recovery Subsystem</b>
|
||||
* @brief <b>(USB) STM32 Clock Recovery Subsystem</b>
|
||||
*
|
||||
* @version 1.0.0
|
||||
*
|
||||
@@ -27,6 +26,8 @@
|
||||
* 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/>.
|
||||
*/
|
||||
/**@{*/
|
||||
|
||||
|
||||
#include <libopencm3/stm32/crs.h>
|
||||
#include <libopencm3/stm32/rcc.h>
|
||||
@@ -46,3 +47,4 @@ void crs_autotrim_usb_enable(void)
|
||||
CRS_CR |= CRS_CR_CEN;
|
||||
}
|
||||
|
||||
/**@}*/
|
||||
Reference in New Issue
Block a user