File: 026_exception.cpp

package info (click to toggle)
doxygen 1.8.8-4
  • links: PTS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 21,648 kB
  • sloc: cpp: 234,386; lex: 34,822; xml: 8,057; python: 2,566; perl: 1,592; ansic: 913; sh: 868; tcl: 594; makefile: 584; php: 445; yacc: 235; objc: 14; java: 1
file content (21 lines) | stat: -rw-r--r-- 594 bytes parent folder | download | duplicates (12) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
// objective: test the \exception, \param, and \tparam commands
// check: class_test.xml

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