diff options
Diffstat (limited to 'os/hal/templates/meta')
| -rw-r--r-- | os/hal/templates/meta/driver.c | 13 | ||||
| -rw-r--r-- | os/hal/templates/meta/driver.h | 13 | ||||
| -rw-r--r-- | os/hal/templates/meta/driver_lld.c | 15 | ||||
| -rw-r--r-- | os/hal/templates/meta/driver_lld.h | 11 |
4 files changed, 28 insertions, 24 deletions
diff --git a/os/hal/templates/meta/driver.c b/os/hal/templates/meta/driver.c index 77b854bd8..e4d6e5748 100644 --- a/os/hal/templates/meta/driver.c +++ b/os/hal/templates/meta/driver.c @@ -18,8 +18,9 @@ */
/**
- * @file XXX.c
- * @brief XXX Driver code.
+ * @file xxx.c
+ * @brief XXX Driver code.
+ *
* @addtogroup XXX
* @{
*/
@@ -46,7 +47,7 @@ /*===========================================================================*/
/**
- * @brief XXX Driver initialization.
+ * @brief XXX Driver initialization.
*/
void xxxInit(void) {
@@ -54,7 +55,7 @@ void xxxInit(void) { }
/**
- * @brief Initializes the standard part of a @p XXXDriver structure.
+ * @brief Initializes the standard part of a @p XXXDriver structure.
*
* @param[in] xxxp pointer to the @p XXXDriver object
*/
@@ -65,7 +66,7 @@ void xxxObjectInit(XXXDriver *xxxp) { }
/**
- * @brief Configures and activates the XXX peripheral.
+ * @brief Configures and activates the XXX peripheral.
*
* @param[in] xxxp pointer to the @p XXXDriver object
* @param[in] config pointer to the @p XXXConfig object
@@ -85,7 +86,7 @@ void xxxStart(XXXDriver *xxxp, const XXXConfig *config) { }
/**
- * @brief Deactivates the XXX peripheral.
+ * @brief Deactivates the XXX peripheral.
*
* @param[in] xxxp pointer to the @p XXXDriver object
*/
diff --git a/os/hal/templates/meta/driver.h b/os/hal/templates/meta/driver.h index 7a54cfcb4..762e54c7c 100644 --- a/os/hal/templates/meta/driver.h +++ b/os/hal/templates/meta/driver.h @@ -18,8 +18,9 @@ */
/**
- * @file xxx.h
- * @brief XXX Driver macros and structures.
+ * @file xxx.h
+ * @brief XXX Driver macros and structures.
+ *
* @addtogroup XXX
* @{
*/
@@ -46,12 +47,12 @@ /*===========================================================================*/
/**
- * @brief Driver state machine possible states.
+ * @brief Driver state machine possible states.
*/
typedef enum {
- XXX_UNINIT = 0, /**< @brief Not initialized. */
- XXX_STOP = 1, /**< @brief Stopped. */
- XXX_READY = 2, /**< @brief Ready. */
+ XXX_UNINIT = 0, /**< @brief Not initialized. */
+ XXX_STOP = 1, /**< @brief Stopped. */
+ XXX_READY = 2, /**< @brief Ready. */
} xxxstate_t;
#include "xxx_lld.h"
diff --git a/os/hal/templates/meta/driver_lld.c b/os/hal/templates/meta/driver_lld.c index 71f8911d0..787ac388d 100644 --- a/os/hal/templates/meta/driver_lld.c +++ b/os/hal/templates/meta/driver_lld.c @@ -18,8 +18,9 @@ */
/**
- * @file templates/xxx_lld.c
- * @brief XXX Driver subsystem low level driver source template.
+ * @file templates/xxx_lld.c
+ * @brief XXX Driver subsystem low level driver source template.
+ *
* @addtogroup XXX_LLD
* @{
*/
@@ -50,16 +51,16 @@ /*===========================================================================*/
/**
- * @brief Low level XXX driver initialization.
+ * @brief Low level XXX driver initialization.
*/
void xxx_lld_init(void) {
}
/**
- * @brief Configures and activates the XXX peripheral.
+ * @brief Configures and activates the XXX peripheral.
*
- * @param[in] xxxp pointer to the @p XXXDriver object
+ * @param[in] xxxp pointer to the @p XXXDriver object
*/
void xxx_lld_start(XXXDriver *xxxp) {
@@ -70,9 +71,9 @@ void xxx_lld_start(XXXDriver *xxxp) { }
/**
- * @brief Deactivates the XXX peripheral.
+ * @brief Deactivates the XXX peripheral.
*
- * @param[in] xxxp pointer to the @p XXXDriver object
+ * @param[in] xxxp pointer to the @p XXXDriver object
*/
void xxx_lld_stop(XXXDriver *xxxp) {
diff --git a/os/hal/templates/meta/driver_lld.h b/os/hal/templates/meta/driver_lld.h index 43824aa94..409523cfb 100644 --- a/os/hal/templates/meta/driver_lld.h +++ b/os/hal/templates/meta/driver_lld.h @@ -18,8 +18,9 @@ */
/**
- * @file templates/xxx_lld.h
- * @brief XXX Driver subsystem low level driver header template.
+ * @file templates/xxx_lld.h
+ * @brief XXX Driver subsystem low level driver header template.
+ *
* @addtogroup XXX_LLD
* @{
*/
@@ -46,15 +47,15 @@ /*===========================================================================*/
/**
- * @brief Driver configuration structure.
- * @note It could be empty on some architectures.
+ * @brief Driver configuration structure.
+ * @note It could be empty on some architectures.
*/
typedef struct {
} XXXConfig;
/**
- * @brief Structure representing an XXX driver.
+ * @brief Structure representing an XXX driver.
*/
typedef struct {
/**
|