benno90
7/21/2019 - 8:31 AM

documentation / doxygen



/** Brief description which ends at this dot. Details follow
 *  here.
 */

    
/**
 * a normal member taking two arguments and returning an integer value.
 * @param a an integer argument.
 * @param s a constant character pointer.
 * @see Javadoc_Test()
 * @see ~Javadoc_Test()
 * @see testMeToo()
 * @see publicVar()
 * @return The test results
 */
int testMe(int a,const char *s);

// one line description of memebers
int var; /**< Detailed description after the member */