Use Doxygen
JavaDoc style:
/** Brief description which ends at this dot. Details follow here.\\
*/\\
class Test\\
{\\
public:\\
/** The constructor's brief description in one line.\\
* A more elaborate description of the constructor.\\
*/\\
Test();\\
\\
/** do some test.\\
* @author Liwei Peng <lpeng@bcm.tmc.edu>\\
* @date 1/20/2005\\
* @param low the low threshold.\\
* @param high the high threshold.\\
* @return 0 if do_test succeeds; 1 if do_test fails.\\
*/\\
int do_test(float low, float high);\\
\\
/** Calculate the sum of an array.\\
* @param[in] data Data array\\
* @param[in] nitems Number of items in the array.\\
* @param[out] sum The sum of the array.\\
*/\\
void calc_sum(int[] data, int nitems, int *sum);\\
\\
}\\
Last modifiedby Liwei Peng (lpeng@bcm.tmc.edu)