/** * @file Class1.h * @brief Header file for Class1 */ #ifndef CLASS1_H #define CLASS1_H /** * @class Class1 * @author author1, author2 * @version 1.0 * @brief short description of Class1 * Detailed description of Class1 * ... */ class Class1 { private: /** * @brief short description of number * @invariant number must be > 0 */ int number; public: /** * Description of method1 * @brief short description * @param i a random number * @param j another random number * @return i plus j */ int method1(int i, int j); /** * @brief this method does nothing */ void method_with_long_name(); /** * @brief show how pre and post conditions work * @pre description of precondition * @post description of postcondition */ void method_with_pre_and_post_conditions(); } #endif