Blame testing/026_exception.cpp

Packit Service 50c9f2
// objective: test the \exception, \param, and \tparam commands
Packit Service 50c9f2
// check: class_test.xml
Packit Service 50c9f2
Packit Service 50c9f2
/** A Test class.
Packit Service 50c9f2
 *  More details about this class.
Packit Service 50c9f2
 *  @tparam T A template parameter.
Packit Service 50c9f2
 */
Packit Service 50c9f2
template<class T> class Test
Packit Service 50c9f2
{
Packit Service 50c9f2
  public:
Packit Service 50c9f2
    /** An example member function.
Packit Service 50c9f2
     *  \param p1 First parameter.
Packit Service 50c9f2
     *  \param p2 Second parameter.
Packit Service 50c9f2
     *  \exception std::out_of_range parameter is out of range. 
Packit Service 50c9f2
     *  \retval  0 if p1 and p2 are equal
Packit Service 50c9f2
     *  \retval -1 if p1 is smaller than p2
Packit Service 50c9f2
     *  \retval  1 if p1 is bigger than p2
Packit Service 50c9f2
     */
Packit Service 50c9f2
    int example(int p1,int p2) throw(std::out_of_range);
Packit Service 50c9f2
};
Packit Service 50c9f2