Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
DocumentationExample.h
Go to the documentation of this file.
1 /*===================================================================
2 
3 The Medical Imaging Interaction Toolkit (MITK)
4 
5 Copyright (c) German Cancer Research Center,
6 Division of Medical and Biological Informatics.
7 All rights reserved.
8 
9 This software is distributed WITHOUT ANY WARRANTY; without
10 even the implied warranty of MERCHANTABILITY or FITNESS FOR
11 A PARTICULAR PURPOSE.
12 
13 See LICENSE.txt or http://www.mitk.org for details.
14 
15 ===================================================================*/
16 
25 class DocumentationExample
26 {
27 public:
32  DocumentationExample();
37  ~DocumentationExample();
38 
51  int ExampleCastCharToInt(int number, const char *name);
52 
63  bool TestWithin(std::string itsAString, int theInt) throw(std::out_of_range);
64 
70  int zero;
71 };
DocumentationExample::~DocumentationExample
~DocumentationExample()
A destructor. A more elaborate description of the destructor.
DocumentationExample::zero
int zero
The public definition of zero.
Definition: DocumentationExample.h:70
DocumentationExample::TestWithin
bool TestWithin(std::string itsAString, int theInt)
Tests whether an integer is within the bounds of a string.
DocumentationExample::DocumentationExample
DocumentationExample()
A constructor. A more elaborate description of the constructor.
DocumentationExample::ExampleCastCharToInt
int ExampleCastCharToInt(int number, const char *name)
Casts the char at position number to an int and returns it.
DocumentationExample
This is a class for showing how to document your code using doxygen.
Definition: DocumentationExample.h:25