Blame testing/026_exception.cpp

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