From 20a20de3ac88ba8ead8b44f3c48435059debe354 Mon Sep 17 00:00:00 2001 From: fps Date: Thu, 12 Sep 2013 12:09:37 +0000 Subject: [PATCH] documentation --- src/XAO/XAO_Exception.hxx | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/XAO/XAO_Exception.hxx b/src/XAO/XAO_Exception.hxx index 00f341ea8..8c9aea26a 100644 --- a/src/XAO/XAO_Exception.hxx +++ b/src/XAO/XAO_Exception.hxx @@ -11,14 +11,29 @@ namespace XAO { + /** + * \class XAO_Exception + * Exception for XAO operations. + */ class XAO_Exception : public std::exception { public: + /** + * Default constructor. + * @param message the exception 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: const char* m_message; -- 2.39.2