Skip to content

Commit ba9c5c3

Browse files
Masmiseim36Masmiseim36
committed
Removed some doxygen warnings
1 parent 7de5c01 commit ba9c5c3

12 files changed

Lines changed: 421 additions & 419 deletions

File tree

‎CMSIS/Core/Include/armv7a.h‎

Lines changed: 376 additions & 378 deletions
Large diffs are not rendered by default.

‎CMSIS/Core/Include/armv7r.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@
197197
#define __IOM volatile /*!< \brief Defines 'read / write' structure member permissions */
198198
#define RESERVED(N, T) T RESERVED##N; // placeholder struct members used for "reserved" areas
199199

200-
/*@} end of group ARMv7-R */
200+
/** @} end of group ARMv7-R */
201201

202202

203203

‎CMSIS/Core/Include/armv8a.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@
257257
#define __IOM volatile /*!< \brief Defines 'read / write' structure member permissions */
258258
#define RESERVED(N, T) T RESERVED##N; // placeholder struct members used for "reserved" areas
259259

260-
/*@} end of group ARMv8-A */
260+
/** @} end of group ARMv8-A */
261261

262262

263263

‎CMSIS/Core/Include/armv8r.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@
252252
#define __IOM volatile /*!< \brief Defines 'read / write' structure member permissions */
253253
#define RESERVED(N, T) T RESERVED##N; // placeholder struct members used for "reserved" areas
254254

255-
/*@} end of group ARMv8-R */
255+
/** @} end of group ARMv8-R */
256256

257257

258258

‎CMSIS/Core/Include/cmsis_armcc.h‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -469,9 +469,9 @@ __attribute__((section(".revsh_text"))) __STATIC_INLINE __ASM int16_t __REVSH(in
469469
/**
470470
\brief Unsigned Saturate
471471
\details Saturates an unsigned value.
472-
\param [in] value Value to be saturated
473-
\param [in] sat Bit position to saturate to (0..31)
474-
\return Saturated value
472+
\param [in] val Value to be saturated
473+
\param [in] sat Bit position to saturate to (0..31)
474+
\return Saturated value
475475
*/
476476
__attribute__((always_inline)) __STATIC_INLINE uint32_t __USAT(int32_t val, uint32_t sat)
477477
{
@@ -493,7 +493,7 @@ __attribute__((section(".revsh_text"))) __STATIC_INLINE __ASM int16_t __REVSH(in
493493
(defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
494494
(defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
495495

496-
/*@}*/ /* end of group CMSIS_Core_InstructionInterface */
496+
/** @} end of group CMSIS_Core_InstructionInterface */
497497

498498

499499
/* ########################### Core Function Access ########################### */
@@ -516,24 +516,24 @@ __attribute__((section(".revsh_text"))) __STATIC_INLINE __ASM int16_t __REVSH(in
516516
*/
517517
/* intrinsic void __disable_irq(void); */
518518

519-
#if ((defined (__arm__ ) || \
519+
#if ((defined (__arm__ )) || \
520520
(defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
521521
(defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) )
522522

523-
/**
524-
\brief Enable FIQ
525-
\details Enables FIQ interrupts by clearing special-purpose register FAULTMASK.
526-
Can only be executed in Privileged modes.
527-
*/
528-
#define __enable_fault_irq __enable_fiq
523+
/**
524+
\brief Enable FIQ
525+
\details Enables FIQ interrupts by clearing special-purpose register FAULTMASK.
526+
Can only be executed in Privileged modes.
527+
*/
528+
#define __enable_fault_irq __enable_fiq
529529

530530

531-
/**
532-
\brief Disable FIQ
533-
\details Disables FIQ interrupts by setting special-purpose register FAULTMASK.
534-
Can only be executed in Privileged modes.
535-
*/
536-
#define __disable_fault_irq __disable_fiq
531+
/**
532+
\brief Disable FIQ
533+
\details Disables FIQ interrupts by setting special-purpose register FAULTMASK.
534+
Can only be executed in Privileged modes.
535+
*/
536+
#define __disable_fault_irq __disable_fiq
537537

538538
#endif /* ( defined (__arm__ ) || \
539539
(defined (__ARM_ARCH_7M__ ) && (__ARM_ARCH_7M__ == 1)) || \
@@ -653,6 +653,6 @@ __STATIC_INLINE void __set_FPSCR(uint32_t fpscr)
653653

654654
#define __SXTAB16_RORn(ARG1, ARG2, ARG3) __SXTAB16(ARG1, __ROR(ARG2, ARG3))
655655
#endif /* ((defined (__ARM_ARCH_7EM__) && (__ARM_ARCH_7EM__ == 1)) ) */
656-
/*@} end of group CMSIS_SIMD_intrinsics */
656+
/** @} end of group CMSIS_SIMD_intrinsics */
657657

658658
#endif /* __CMSIS_ARMCC_H */

‎CMSIS/Core/Include/cmsis_armclang.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -490,9 +490,9 @@ __STATIC_FORCEINLINE uint8_t __CLZ(uint32_t value)
490490
/**
491491
\brief Unsigned Saturate
492492
\details Saturates an unsigned value.
493-
\param [in] value Value to be saturated
494-
\param [in] sat Bit position to saturate to (0..31)
495-
\return Saturated value
493+
\param [in] val Value to be saturated
494+
\param [in] sat Bit position to saturate to (0..31)
495+
\return Saturated value
496496
*/
497497
__STATIC_FORCEINLINE uint32_t __USAT(int32_t val, uint32_t sat)
498498
{

‎CMSIS/Core/Include/cmsis_armclang_ltm.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -498,9 +498,9 @@ __STATIC_FORCEINLINE uint8_t __CLZ(uint32_t value)
498498
/**
499499
\brief Unsigned Saturate
500500
\details Saturates an unsigned value.
501-
\param [in] value Value to be saturated
502-
\param [in] sat Bit position to saturate to (0..31)
503-
\return Saturated value
501+
\param [in] val Value to be saturated
502+
\param [in] sat Bit position to saturate to (0..31)
503+
\return Saturated value
504504
*/
505505
__STATIC_FORCEINLINE uint32_t __USAT(int32_t val, uint32_t sat)
506506
{

‎CMSIS/Core/Include/cmsis_gcc.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -629,9 +629,9 @@ __STATIC_FORCEINLINE uint8_t __CLZ(uint32_t value)
629629
/**
630630
\brief Unsigned Saturate
631631
\details Saturates an unsigned value.
632-
\param [in] value Value to be saturated
633-
\param [in] sat Bit position to saturate to (0..31)
634-
\return Saturated value
632+
\param [in] val Value to be saturated
633+
\param [in] sat Bit position to saturate to (0..31)
634+
\return Saturated value
635635
*/
636636
__STATIC_FORCEINLINE uint32_t __USAT(int32_t val, uint32_t sat)
637637
{

‎CMSIS/Core/Include/cmsis_tiarmclang_corem.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -551,9 +551,9 @@ __STATIC_FORCEINLINE int32_t __SSAT(int32_t val, uint32_t sat)
551551
/**
552552
\brief Unsigned Saturate
553553
\details Saturates an unsigned value.
554-
\param [in] value Value to be saturated
555-
\param [in] sat Bit position to saturate to (0..31)
556-
\return Saturated value
554+
\param [in] val Value to be saturated
555+
\param [in] sat Bit position to saturate to (0..31)
556+
\return Saturated value
557557
*/
558558
__STATIC_FORCEINLINE uint32_t __USAT(int32_t val, uint32_t sat)
559559
{

‎CMSIS/DoxyGen/Core/Core.dxy.in‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ PROJECT_NAME = "CMSIS-Core (Cortex-M)"
4747
# could be handy for archiving the generated documentation or if some version
4848
# control system is used.
4949

50-
PROJECT_NUMBER = "Version 5.7.0"
50+
PROJECT_NUMBER = "Version 6.0.0"
5151

5252
# Using the PROJECT_BRIEF tag one can provide an optional one line description
5353
# for a project that appears at the top of each page and should give viewer a

0 commit comments

Comments
 (0)