Changeset 60 in pacpusframework

Timestamp:

Jan 9, 2013, 12:38:31 PM (12 years ago)

Author:

sgosseli

Message:

Write the documentation of DbiteException.

Location:

trunk

Files:

• include/Pacpus/kernel/DbiteException.h (modified) (2 diffs)
• src/FileLib/src/DbiteException.cpp (modified) (2 diffs)

trunk/include/Pacpus/kernel/DbiteException.h

@@ -1 +1 @@
 /**
  *
- * Distributed under the UTC Heudiascy Pacpus License, Version 1.0.
- * Copyright (c) UTC Heudiasyc 2010 - 2013. All rights reserved.
- *
- * See the LICENSE file for more information or a copy at:
- *   http://www.hds.utc.fr/~kurdejma/LICENSE_1_0.txt
- *
+ * This file is part of the PACPUS framework distributed under the 
+ * CECILL-C License, Version 1.0.
+ * 
+ * @author  Marek Kurdej
+ * @date    December, 2012
+ * @version $Id$
+ * @copyright Copyright (c) UTC/CNRS Heudiasyc 2005 - 2013. All rights reserved.
+ * 
  */
 
@@ -19 +21 @@
 namespace pacpus {
 
+/** DbiteException
+ * @brief Exception thrown when an error manipulation a dbite file occured.
+ */
 class FILELIB_API DbiteException
-        : public std::exception
+    : public std::exception
 {
 public:
-    /// @todo Documentation
-    DbiteException();
-    /// @todo Documentation
-    DbiteException(const char * what);
-    /// @todo Documentation
+    /** Ctor of DbiteException.
+     * @param what Information about the exception.
+     */
+    DbiteException(const std::string& what);
+
+    /** Dtor of DbiteException. */
     ~DbiteException() throw();
 
-    /// @todo Documentation
-    virtual const char * what() const throw();
+    /** Get more information about the error.
+     * @return Message containing information about the error.
+     */
+    virtual const char* what() const throw();
 
 private:

trunk/src/FileLib/src/DbiteException.cpp

@@ -13 +13 @@
 using namespace pacpus;
 
-DbiteException::DbiteException()
-{
-}
-
-DbiteException::DbiteException(const char * what)
+DbiteException::DbiteException(const std::string& what)
     : mWhat(what)
 {
@@ -26 +22 @@
 }
 
-const char * DbiteException::what() const throw()
+const char* DbiteException::what() const throw()
 {
     return mWhat.c_str();