diff options
| author | hathach <[email protected]> | 2014-03-24 12:35:44 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2014-03-24 12:35:44 +0700 |
| commit | a8406060d1037ede08b48d628947d3ad98aeecd7 (patch) | |
| tree | 202318dddf8e6021fbb29589d348e1a8054f4eec /tinyusb/common | |
| parent | cf60e374aa60507457a193bf12385f9e0f41f035 (diff) | |
doxygen documenting
Diffstat (limited to 'tinyusb/common')
| -rw-r--r-- | tinyusb/common/assertion.h | 10 | ||||
| -rw-r--r-- | tinyusb/common/binary.h | 7 | ||||
| -rw-r--r-- | tinyusb/common/common.h | 2 | ||||
| -rw-r--r-- | tinyusb/common/fifo.h | 5 | ||||
| -rw-r--r-- | tinyusb/common/timeout_timer.h | 5 | ||||
| -rw-r--r-- | tinyusb/common/tusb_errors.h | 8 |
6 files changed, 11 insertions, 26 deletions
diff --git a/tinyusb/common/assertion.h b/tinyusb/common/assertion.h index 2a847731a..329bc11db 100644 --- a/tinyusb/common/assertion.h +++ b/tinyusb/common/assertion.h @@ -36,12 +36,10 @@ */
/**************************************************************************/
-/** \ingroup TBD
- * \defgroup TBD
- * \brief TBD
- *
- * @{
- */
+/** \ingroup Group_Common
+ * \defgroup group_assertion Assertion
+ * @{ */
+
#ifndef _TUSB_ASSERTION_H_
#define _TUSB_ASSERTION_H_
diff --git a/tinyusb/common/binary.h b/tinyusb/common/binary.h index 6beeb8595..6860295de 100644 --- a/tinyusb/common/binary.h +++ b/tinyusb/common/binary.h @@ -36,12 +36,10 @@ */
/**************************************************************************/
-/** \addtogroup Group_Common Common Files
- * @{
- * \defgroup Group_Binary binary.h
+/** \ingroup Group_Common
+ * \defgroup Group_Binary Binary
* @{ */
-
#ifndef _TUSB_BINARY_H_
#define _TUSB_BINARY_H_
@@ -131,4 +129,3 @@ static inline uint32_t bit_set_range(uint32_t value, uint8_t start, uint8_t end, #endif /* _TUSB_BINARY_H_ */
/** @} */
-/** @} */
diff --git a/tinyusb/common/common.h b/tinyusb/common/common.h index b63593ac6..6a6e00701 100644 --- a/tinyusb/common/common.h +++ b/tinyusb/common/common.h @@ -36,7 +36,7 @@ */
/**************************************************************************/
-/** \addtogroup Group_Common Common Files
+/** \defgroup Group_Common Common Files
* @{
* \defgroup Group_CommonH common.h
* @{ */
diff --git a/tinyusb/common/fifo.h b/tinyusb/common/fifo.h index 98a8fbcd2..113c21a5d 100644 --- a/tinyusb/common/fifo.h +++ b/tinyusb/common/fifo.h @@ -37,9 +37,8 @@ /**************************************************************************/
/** \ingroup Group_Common
- *
- * @{
- */
+ * \defgroup group_fifo fifo
+ * @{ */
#ifndef _TUSB_FIFO_H_
#define _TUSB_FIFO_H_
diff --git a/tinyusb/common/timeout_timer.h b/tinyusb/common/timeout_timer.h index b1919638d..885b3901c 100644 --- a/tinyusb/common/timeout_timer.h +++ b/tinyusb/common/timeout_timer.h @@ -36,8 +36,7 @@ */
/**************************************************************************/
-/** \addtogroup Group_Common Common Files
- * @{
+/** \ingroup Group_Common Common Files
* \defgroup Group_TimeoutTimer timeout timer
* @{ */
@@ -76,5 +75,3 @@ static inline bool timeout_expired(timeout_timer_t* tt) #endif /* _TUSB_TIMEOUT_TTIMER_H_ */
/** @} */
-/** @} */
-
diff --git a/tinyusb/common/tusb_errors.h b/tinyusb/common/tusb_errors.h index 6d991c38a..81b1f0906 100644 --- a/tinyusb/common/tusb_errors.h +++ b/tinyusb/common/tusb_errors.h @@ -36,12 +36,6 @@ */
/**************************************************************************/
-/** \file
- * \brief Error Header
- *
- * \note TBD
- */
-
/** \ingroup Group_Common
* \defgroup Group_Error Error Codes
* @{
@@ -119,4 +113,4 @@ extern char const* const TUSB_ErrorStr[TUSB_ERROR_COUNT]; #endif /* _TUSB_ERRORS_H_ */
- /** @} */
+/** @} */
|