doxygen documenting

This commit is contained in:
hathach
2014-03-24 12:35:44 +07:00
parent cf60e374aa
commit a8406060d1
19 changed files with 29 additions and 71 deletions

View File

@@ -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_

View File

@@ -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_ */
/** @} */
/** @} */

View File

@@ -36,7 +36,7 @@
*/
/**************************************************************************/
/** \addtogroup Group_Common Common Files
/** \defgroup Group_Common Common Files
* @{
* \defgroup Group_CommonH common.h
* @{ */

View File

@@ -37,9 +37,8 @@
/**************************************************************************/
/** \ingroup Group_Common
*
* @{
*/
* \defgroup group_fifo fifo
* @{ */
#ifndef _TUSB_FIFO_H_
#define _TUSB_FIFO_H_

View File

@@ -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_ */
/** @} */
/** @} */

View File

@@ -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_ */
/** @} */
/** @} */