C/C++ doxygen注釋樣本

/**<br /> * @filefilename.h<br /> * @briefBrief description<br /> * @authorJoaquin Jin<br /> * @version1.0<br /> * @date2011.3.1<br /> * @bugIt has not been implemented yet<br /> * @warningNo<br /> */<br />#include <iostream><br />using namespace std;<br />/**<br /> * A macro<br /> */<br />#define ABS(x) (((x)>0)?(x):-(x))<br />/**<br /> * A structure<br /> * details<br /> */<br />struct Type {<br />int x;/**< member */<br />};<br />typedef struct Object Object/**< Ojbect type */<br />/**<br /> * Vehicle class<br /> * @extends Object<br /> */<br />struct Vehicle {<br />Object base;/**< Base */<br />};<br />/** An enum type. More details */<br />enum EType {<br />Val1,/**< enum value 1 */<br />Val2/**< enum value 2 */<br />};<br />/**<br /> * A Test class<br /> * More details<br /> */<br />class Test {<br />public:<br />/**<br /> * Brief description<br /> * Detailed description<br /> */<br />Test();<br />/**<br /> * Brief description<br /> * Detailed description<br /> */<br />~Test();<br />/**<br /> * a member function<br /> * @param a the augument<br /> * @param b the augument<br /> * @see Test()<br /> * @see ~Test()<br /> * @return the result<br /> */<br />int Fun(int a, int b);<br />void data(int);/**< A member function. Details */<br />private:<br />int data;/**< private data */<br />/**<br /> * another private data<br /> */<br />char another_one;<br />};<br />