documentation

This commit is contained in:
fps 2013-09-12 12:09:37 +00:00
parent a0d5e8f60e
commit 20a20de3ac

View File

@ -11,14 +11,29 @@
namespace XAO namespace XAO
{ {
/**
* \class XAO_Exception
* Exception for XAO operations.
*/
class XAO_Exception : public std::exception class XAO_Exception : public std::exception
{ {
public: public:
/**
* Default constructor.
* @param message the exception message.
*/
XAO_Exception(const char* message) : m_message(message) XAO_Exception(const char* message) : m_message(message)
{ {
} }
virtual const char* what() const throw () { return m_message; } /**
* Returns the error message.
* @return the error message.
*/
virtual const char* what() const throw ()
{
return m_message;
}
private: private:
const char* m_message; const char* m_message;