docs.h (867B)
1 #ifndef DOCS_H 2 #define DOCS_H 3 4 /** 5 * Short explanation 6 * 7 * This is a longer explanation 8 * that spans multiple lines 9 * 10 * @param[in] input some input 11 * @param[out] flags some flags 12 * @param[in,out] buf some input and output buffer 13 * @param option some option 14 * @return a random value 15 */ 16 int a_function(char *input, int *flags, char *buf, int option); 17 18 int no_comment_function(void); 19 20 /** 21 * <br /> 22 * <a href="http://example.org/"> 23 * </a> 24 */ 25 void b_function(void); 26 27 /** 28 * @tparam T1 some type of foo 29 * @tparam T2 some type of bar 30 * @tparam T3 some type of baz 31 */ 32 template<typename T1, template<typename T2> class T3> 33 void c_function(T3<int> xxx); 34 35 /** 36 * abc \em foo \b bar 37 */ 38 void d_function(void); 39 40 /** 41 * \verbatim 42 * foo bar 43 * baz 44 * \endverbatim 45 */ 46 void e_function(void); 47 48 /** 49 * \brief this is a function. 50 */ 51 int f_function(void); 52 53 54 #endif