diff options
Diffstat (limited to 'os/various')
| -rw-r--r-- | os/various/chprintf.c | 2 | ||||
| -rw-r--r-- | os/various/chrtclib.c | 14 | ||||
| -rw-r--r-- | os/various/chrtclib.h | 12 | ||||
| -rw-r--r-- | os/various/various.dox | 20 |
4 files changed, 40 insertions, 8 deletions
diff --git a/os/various/chprintf.c b/os/various/chprintf.c index 7b02ab3ba..78a4a8ac1 100644 --- a/os/various/chprintf.c +++ b/os/various/chprintf.c @@ -264,3 +264,5 @@ unsigned_common: }
}
}
+
+/** @} */
diff --git a/os/various/chrtclib.c b/os/various/chrtclib.c index f76f91d65..1a0a5487d 100644 --- a/os/various/chrtclib.c +++ b/os/various/chrtclib.c @@ -22,6 +22,14 @@ aka barthess.
*/
+/**
+ * @file chrtclib.c
+ * @brief RTC time conversion utilities code.
+ *
+ * @addtogroup chrtclib
+ * @{
+ */
+
#include <time.h>
#include "ch.h"
@@ -31,7 +39,7 @@ #if (defined(STM32F4XX) || defined(STM32F2XX) || defined(STM32L1XX) || \
defined(STM32F1XX) || defined(STM32F10X_MD) || defined(STM32F10X_LD) || \
- defined(STM32F10X_HD))
+ defined(STM32F10X_HD) || defined(__DOXYGEN__))
#if STM32_RTC_IS_CALENDAR
/**
* @brief Converts from STM32 BCD to canonicalized time format.
@@ -194,6 +202,7 @@ time_t rtcGetTimeUnixSec(RTCDriver *rtcp) { * @brief Sets RTC time.
*
* @param[in] rtcp pointer to RTC driver structure
+ * @param[in] tv_sec time specification
* @return Unix time value in seconds.
*
* @api
@@ -285,6 +294,7 @@ time_t rtcGetTimeUnixSec(RTCDriver *rtcp) { * @brief Sets RTC time.
*
* @param[in] rtcp pointer to RTC driver structure
+ * @param[in] tv_sec time specification
* @return Unix time value in seconds.
*
* @api
@@ -342,3 +352,5 @@ uint32_t rtcGetTimeFat(RTCDriver *rtcp) { fattime |= (timp->tm_year - 80) << 25;
return fattime;
}
+
+/** @} */
diff --git a/os/various/chrtclib.h b/os/various/chrtclib.h index 7b3493636..c41706f87 100644 --- a/os/various/chrtclib.h +++ b/os/various/chrtclib.h @@ -22,19 +22,19 @@ aka barthess.
*/
-#ifndef CHRTCLIB_H_
-#define CHRTCLIB_H_
-
-#include <time.h>
-
/**
* @file chrtclib.h
- * @brief Various time conversion functionality.
+ * @brief RTC time conversion utilities header.
*
* @addtogroup chrtclib
* @{
*/
+#ifndef CHRTCLIB_H_
+#define CHRTCLIB_H_
+
+#include <time.h>
+
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
diff --git a/os/various/various.dox b/os/various/various.dox index d221c9af5..ac833a7e0 100644 --- a/os/various/various.dox +++ b/os/various/various.dox @@ -75,7 +75,25 @@ */
/**
- * @defgroup lis302dl Interface module for LIS302DL MEMS.
+ * @defgroup chrtclib RTC time conversion utilities
+ *
+ * @brief RTC time conversion utilities.
+ *
+ * @ingroup various
+ */
+
+/**
+ * @defgroup chprintf System formatted print
+ *
+ * @brief System formatted print service.
+ * @details This module implements printf()-like function able to send data
+ * to any module implementing a @p BaseSequentialStream interface.
+ *
+ * @ingroup various
+ */
+
+/**
+ * @defgroup lis302dl Interface module for LIS302DL MEMS
*
* @brief Interface module for LIS302DL MEMS.
* @details This module implements a generic interface for the LIS302DL
|
