doxygen example

#ifndef _DOXYGEN_SAMPLE_H
#define  _DOXYGEN_SAMPLE_H

/*! \mainpage My Personal Index Page
 *
 * \section intro_sec Introduction
 *
 * This is the introduction.
 *
 * \section install_sec Installation
 *
 * \subsection step1 Step 1: Opening the box
 *
 */

#include <stdio.h>
 
/** 
 * @file doxygen_sample.h
 * @Author ted  ([email protected])
 * @date september, 2011
 * @version 0.1
 * @brief This is a demo for doxygen \n
 *
 * Include many key word of doxygen
 */

/**
 * @name  Example API Actions
 * @brief Example actions available
 * @ingroup example
 *
 * This API provides certain actions as an example
 */


/*! \var typedef unsigned int UINT32
    \brief A type definition for a .
    
    Details.
*/
typedef unsigned int UINT32;

/*! \var int errno
    \brief Contains the last error code.

    \warning Not thread safe!
*/
int errno;

/* @def MAX(a,b)
 * @brief A macro that returns the maximum of \a a and \a b.
 * Details.
*/
#define MAX(a,b) (((a)>(b))?(a):(b))


/*!
    \brief Writes \a count bytes from \a buf to the filedescriptor \a fd.
    \param fd The descriptor to write to.
    \param buf The data buffer to write.
    \param count The number of bytes to write.
*/
size_t write(int fd ,const char *buf , size_t count);

/*! \fn int open(const char *pathname,int flags)
    \brief Opens a file descriptor.

    \param pathname The name of the descriptor.
    \param flags Opening flags.
*/
int open(const char *pathname ,int flags);

/*! \fn int close(int fd)
    \brief Closes the file descriptor \a fd.
    \param fd The descriptor to close.
*/
int close(int fd);

/*! \fn int read(int fd,char *buf,size_t count)
    \brief Read bytes from a file descriptor.
    \param fd The descriptor to read from.
    \param buf The buffer to read into.
    \param count The number of bytes to read.
*/
int read(int fd,char *buf,size_t count);

/**
 * @fn example_doxygen(int times)
 * @brief this just doxygen example, printf \a times times
 *
 * @todo add more key word here
 * @bug  there is no bug
 *
 * @warning this just do noting
 *
 * @param [in] repeate Number of times to do noting.
 *
 * @retval TRUE  successfully did noting
 * @retval FALSE Oops, did someting
 *
 * Example Usage:
 * @code 
 *   example_doxygen(3);  
 * @endcode
 */
int example_doxygen(int times);


#endif