From d3d68c876fd915af4064975e1db28ef1955b6695 Mon Sep 17 00:00:00 2001
From: Oleg Hahm <oleg@hobbykeller.org>
Date: Sun, 30 Nov 2014 21:18:24 +0100
Subject: [PATCH] doc: use @brief for single defines
---
boards/mbed_lpc1768/include/board.h | 6 +++---
boards/pca10000/include/board.h | 2 +-
cpu/stm32f1/include/cpu-conf.h | 8 ++++----
drivers/include/lps331ap.h | 2 +-
drivers/include/rgbled.h | 2 +-
drivers/include/servo.h | 2 +-
6 files changed, 11 insertions(+), 11 deletions(-)
diff --git a/boards/mbed_lpc1768/include/board.h b/boards/mbed_lpc1768/include/board.h
index 2ef6cfb25d..4c766b13e7 100644
--- a/boards/mbed_lpc1768/include/board.h
+++ b/boards/mbed_lpc1768/include/board.h
@@ -33,12 +33,12 @@ extern "C" {
#endif
/**
- * @name The nominal CPU core clock in this board
+ * @brief The nominal CPU core clock in this board
*/
#define F_CPU (96000000)
/**
- * @name Assign the peripheral timer to be used as hardware timer
+ * @brief Assign the peripheral timer to be used as hardware timer
*/
#define HW_TIMER TIMER_0
@@ -89,7 +89,7 @@ extern "C" {
/** @} */
/**
- * @name define radio packet length
+ * @brief define radio packet length
*/
typedef uint8_t radio_packet_length_t;
diff --git a/boards/pca10000/include/board.h b/boards/pca10000/include/board.h
index 8a8cda4e89..5b370c8e1d 100644
--- a/boards/pca10000/include/board.h
+++ b/boards/pca10000/include/board.h
@@ -34,7 +34,7 @@ extern "C" {
#define F_CPU (16000000UL)
/**
- * @name Assign the hardware timer
+ * @brief Assign the hardware timer
*/
#define HW_TIMER TIMER_0
diff --git a/cpu/stm32f1/include/cpu-conf.h b/cpu/stm32f1/include/cpu-conf.h
index d60bafe135..6cbf818b0c 100644
--- a/cpu/stm32f1/include/cpu-conf.h
+++ b/cpu/stm32f1/include/cpu-conf.h
@@ -20,8 +20,8 @@
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/
-#ifndef CPUCONF_H_
-#define CPUCONF_H_
+#ifndef __CPU_CONF_H
+#define __CPU_CONF_H
#include "stm32f10x.h"
@@ -56,12 +56,12 @@ extern "C" {
/** @} */
/**
- * @name Length for reading CPU_ID
+ * @brief Length for reading CPU_ID
*/
#define CPUID_ID_LEN (12)
/**
- * @name Definition of different panic modes
+ * @brief Definition of different panic modes
*/
typedef enum {
HARD_FAULT,
diff --git a/drivers/include/lps331ap.h b/drivers/include/lps331ap.h
index 9ab54f09cb..b732fd4ca5 100644
--- a/drivers/include/lps331ap.h
+++ b/drivers/include/lps331ap.h
@@ -31,7 +31,7 @@ extern "C" {
#include "periph/i2c.h"
/**
- * @name The sensors default I2C address
+ * @brief The sensors default I2C address
*/
#define LPS331AP_DEFAULT_ADDRESS 0x5c
diff --git a/drivers/include/rgbled.h b/drivers/include/rgbled.h
index 431a17da4e..f3ea0b3740 100644
--- a/drivers/include/rgbled.h
+++ b/drivers/include/rgbled.h
@@ -29,7 +29,7 @@ extern "C" {
#endif
/**
- * @name Descriptor struct for rgbleds
+ * @brief Descriptor struct for rgbleds
*/
typedef struct {
pwm_t device;
diff --git a/drivers/include/servo.h b/drivers/include/servo.h
index 830b9cdae5..6d0a9d03cc 100644
--- a/drivers/include/servo.h
+++ b/drivers/include/servo.h
@@ -28,7 +28,7 @@ extern "C" {
#endif
/**
- * @name Descriptor struct for a servo
+ * @brief Descriptor struct for a servo
*/
typedef struct {
pwm_t device; /**< the PWM device driving the servo */
--
GitLab