Changeset 66 in pacpusframework for trunk/include/Pacpus/PacpusTools/math/math_exception.hpp

Timestamp:

Jan 9, 2013, 5:54:11 PM (12 years ago)

Author:

Marek Kurdej

Message:

Documentation: file info.

File:

• trunk/include/Pacpus/PacpusTools/math/math_exception.hpp (modified) (1 diff)

trunk/include/Pacpus/PacpusTools/math/math_exception.hpp

@@ -1 @@
-#ifndef __MATH_EXCEPTION_HPP__
-#define __MATH_EXCEPTION_HPP__
+// This file is part of the PACPUS framework distributed under the
+// CECILL-C License, Version 1.0.
+// 
+/// @file
+/// @author  Firstname Surname <firstname.surname@utc.fr>
+/// @date    Month, Year
+/// @version $Id$
+/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
+/// @brief Brief description.
+///
+/// Detailed description.
+
+#ifndef PACPUS_MATH_EXCEPTION_HPP
+#define PACPUS_MATH_EXCEPTION_HPP
 
 namespace math {
 
-   /*!
-    * \class math_error
-    * \brief This class describes the math exception
-    */
-    class math_error : public std::logic_error
-    {
-      public:
-        /*!
-         * \brief Constructor
-         * \param  what_arg : a string describing the math problem
-         */
-        math_error (const std::string& what_arg) : logic_error( what_arg) {}
-     };
+/*!
+* \class math_error
+* \brief This class describes the math exception
+*/
+class math_error
+    : public std::logic_error
+{
+  public:
+    /*!
+     * \brief Constructor
+     * \param  what_arg : a string describing the math problem
+     */
+    math_error (const std::string& what_arg) : logic_error( what_arg) {}
+ };
 
-};
-#endif
+} // namespace math
+
+#endif // PACPUS_MATH_EXCEPTION_HPP