Documentation for exceptions.

--HG--
branch : feature

exception/vexception.h

@@ -33,49 +33,49 @@
 #include <QException>
 
 /**
- * @brief The VException class
+ * @brief The VException class parent for all exception. Could be use for abstract exception
  */
 class VException : public QException
 {
 public:
                       /**
-                       * @brief VException
+                       * @brief VException constructor exception
-                       * @param what
+                       * @param what string with error
                        */
                       VException(const QString &what);
                       /**
-                       * @brief VException
+                       * @brief VException copy constructor
-                       * @param e
+                       * @param e exception
                        */
                       VException(const VException &e):what(e.What()){}
     virtual           ~VException() Q_DECL_NOEXCEPT_EXPR(true){}
     /**
-     * @brief raise
+     * @brief raise method raise for exception
      */
     inline void       raise() const { throw *this; }
     /**
-     * @brief clone
+     * @brief clone clone exception
-     * @return
+     * @return new exception
      */
     inline VException *clone() const { return new VException(*this); }
     /**
-     * @brief ErrorMessage
+     * @brief ErrorMessage return main error message
-     * @return
+     * @return error message
      */
     virtual QString   ErrorMessage() const;
     /**
-     * @brief DetailedInformation
+     * @brief DetailedInformation return detailed information about error
-     * @return
+     * @return detailed information
      */
     virtual QString   DetailedInformation() const { return QString(); }
     /**
-     * @brief What
+     * @brief What return string with error
-     * @return
+     * @return string with error
      */
     inline QString    What() const {return what;}
 protected:
     /**
-     * @brief what
+     * @brief what string with error
      */
     QString           what;
 };

exception/vexceptionbadid.h

@@ -32,54 +32,54 @@
 #include "vexception.h"
 
 /**
- * @brief The VExceptionBadId class
+ * @brief The VExceptionBadId class for exception bad id
  */
 class VExceptionBadId : public VException
 {
 public:
                     /**
-                     * @brief VExceptionBadId
+                     * @brief VExceptionBadId exception bad id
-                     * @param what
+                     * @param what string with error
-                     * @param id
+                     * @param id id
                      */
                     VExceptionBadId(const QString &what, const qint64 &id)
                         :VException(what), id(id), key(QString()){}
                     /**
-                     * @brief VExceptionBadId
+                     * @brief VExceptionBadId exception bad id
-                     * @param what
+                     * @param what string with error
-                     * @param key
+                     * @param key string key
                      */
                     VExceptionBadId(const QString &what, const QString &key)
                         :VException(what), id(0), key(key){}
                     /**
-                     * @brief VExceptionBadId
+                     * @brief VExceptionBadId copy constructor
-                     * @param e
+                     * @param e exception
                      */
                     VExceptionBadId(const VExceptionBadId &e)
                         :VException(e), id(e.BadId()), key(e.BadKey()){}
     virtual         ~VExceptionBadId() Q_DECL_NOEXCEPT_EXPR(true){}
     /**
-     * @brief ErrorMessage
+     * @brief ErrorMessage return main error message
-     * @return
+     * @return main error message
      */
     virtual QString ErrorMessage() const;
     /**
-     * @brief BadId
+     * @brief BadId return bad id
-     * @return
+     * @return id
      */
     inline qint64   BadId() const {return id; }
     /**
-     * @brief BadKey
+     * @brief BadKey return bad key
-     * @return
+     * @return key
      */
     inline QString  BadKey() const {return key; }
 protected:
     /**
-     * @brief id
+     * @brief id id
      */
     qint64          id;
     /**
-     * @brief key
+     * @brief key key
      */
     QString         key;
 };

exception/vexceptionconversionerror.h

@@ -32,37 +32,37 @@
 #include "vexception.h"
 
 /**
- * @brief The VExceptionConversionError class
+ * @brief The VExceptionConversionError class for exception of conversion error
  */
 class VExceptionConversionError : public VException
 {
 public:
                     /**
-                     * @brief VExceptionConversionError
+                     * @brief VExceptionConversionError exception conversion error
-                     * @param what
+                     * @param what string with error
-                     * @param str
+                     * @param str string, where happend error
                      */
                     VExceptionConversionError(const QString &what, const QString &str);
                     /**
-                     * @brief VExceptionConversionError
+                     * @brief VExceptionConversionError copy constructor
-                     * @param e
+                     * @param e exception
                      */
                     VExceptionConversionError(const VExceptionConversionError &e)
                         :VException(e), str(e.String()){}
     virtual         ~VExceptionConversionError() Q_DECL_NOEXCEPT_EXPR(true) {}
     /**
-     * @brief ErrorMessage
+     * @brief ErrorMessage return main error message
-     * @return
+     * @return main error message
      */
     virtual QString ErrorMessage() const;
     /**
-     * @brief String
+     * @brief String return string, where happend error
-     * @return
+     * @return string
      */
     inline QString  String() const {return str;}
 protected:
     /**
-     * @brief str
+     * @brief str string, where happend error
      */
     QString         str;
 };

exception/vexceptionemptyparameter.h

@@ -32,71 +32,71 @@
 #include "vexception.h"
 
 /**
- * @brief The VExceptionEmptyParameter class
+ * @brief The VExceptionEmptyParameter class for exception empty parameter
  */
 class VExceptionEmptyParameter : public VException
 {
 public:
                     /**
-                     * @brief VExceptionEmptyParameter
+                     * @brief VExceptionEmptyParameter exception empty parameter
-                     * @param what
+                     * @param what string with error
-                     * @param name
+                     * @param name name of attribute where error
-                     * @param domElement
+                     * @param domElement dom element
                      */
                     VExceptionEmptyParameter(const QString &what, const QString &name, const QDomElement &domElement);
                     /**
-                     * @brief VExceptionEmptyParameter
+                     * @brief VExceptionEmptyParameter copy constructor
-                     * @param e
+                     * @param e exception
                      */
                     VExceptionEmptyParameter(const VExceptionEmptyParameter &e)
                         :VException(e), name(e.Name()), tagText(e.TagText()), tagName(e.TagName()),
                           lineNumber(e.LineNumber()){}
     virtual         ~VExceptionEmptyParameter() Q_DECL_NOEXCEPT_EXPR(true) {}
     /**
-     * @brief ErrorMessage
+     * @brief ErrorMessage return main error message
-     * @return
+     * @return main error message
      */
     virtual QString ErrorMessage() const;
     /**
-     * @brief DetailedInformation
+     * @brief DetailedInformation return detailed information about error
-     * @return
+     * @return detailed information
      */
     virtual QString DetailedInformation() const;
     /**
-     * @brief Name
+     * @brief Name return name of attribute where error
-     * @return
+     * @return name
      */
     inline QString  Name() const {return name;}
     /**
-     * @brief TagText
+     * @brief TagText return tag text
-     * @return
+     * @return tag text
      */
     inline QString  TagText() const {return tagText;}
     /**
-     * @brief TagName
+     * @brief TagName return tag name
-     * @return
+     * @return tag name
      */
     inline QString  TagName() const {return tagName;}
     /**
-     * @brief LineNumber
+     * @brief LineNumber return line number of tag
-     * @return
+     * @return line number
      */
     inline qint32   LineNumber() const {return lineNumber;}
 protected:
     /**
-     * @brief name
+     * @brief name name attribute
      */
     QString         name;
     /**
-     * @brief tagText
+     * @brief tagText tag text
      */
     QString         tagText;
     /**
-     * @brief tagName
+     * @brief tagName tag name
      */
     QString         tagName;
     /**
-     * @brief lineNumber
+     * @brief lineNumber line number
      */
     qint32          lineNumber;
 };

exception/vexceptionobjecterror.h

@@ -32,75 +32,75 @@
 #include "vexception.h"
 
 /**
- * @brief The VExceptionObjectError class
+ * @brief The VExceptionObjectError class for exception object error
  */
 class VExceptionObjectError : public VException
 {
 public:
                     /**
-                     * @brief VExceptionObjectError
+                     * @brief VExceptionObjectError exception object error
-                     * @param what
+                     * @param what string with error
-                     * @param domElement
+                     * @param domElement dom element
                      */
                     VExceptionObjectError(const QString &what, const QDomElement &domElement);
                     /**
-                     * @brief VExceptionObjectError
+                     * @brief VExceptionObjectError copy constructor
-                     * @param e
+                     * @param e exception
                      */
                     VExceptionObjectError(const VExceptionObjectError &e)
                         :VException(e), tagText(e.TagText()), tagName(e.TagName()), lineNumber(e.LineNumber()),
                           moreInfo(e.MoreInformation()){}
     virtual         ~VExceptionObjectError() Q_DECL_NOEXCEPT_EXPR(true) {}
     /**
-     * @brief ErrorMessage
+     * @brief ErrorMessage return main error message
-     * @return
+     * @return main error message
      */
     virtual QString ErrorMessage() const;
     /**
-     * @brief DetailedInformation
+     * @brief DetailedInformation return detailed information about error
-     * @return
+     * @return detailed information
      */
     virtual QString DetailedInformation() const;
     /**
-     * @brief TagText
+     * @brief TagText return tag text
-     * @return
+     * @return tag text
      */
     inline QString  TagText() const {return tagText;}
     /**
-     * @brief TagName
+     * @brief TagName return tag name
-     * @return
+     * @return tag name
      */
     inline QString  TagName() const {return tagName;}
     /**
-     * @brief LineNumber
+     * @brief LineNumber return line number in file
-     * @return
+     * @return line number
      */
     inline qint32   LineNumber() const {return lineNumber;}
     /**
-     * @brief AddMoreInformation
+     * @brief AddMoreInformation add more information for error
-     * @param info
+     * @param info information
      */
     void            AddMoreInformation(const QString &info);
     /**
-     * @brief MoreInformation
+     * @brief MoreInformation return more information for error
-     * @return
+     * @return information
      */
     inline QString  MoreInformation() const {return moreInfo;}
 protected:
     /**
-     * @brief tagText
+     * @brief tagText tag text
      */
     QString         tagText;
     /**
-     * @brief tagName
+     * @brief tagName tag name
      */
     QString         tagName;
     /**
-     * @brief lineNumber
+     * @brief lineNumber line number
      */
     qint32          lineNumber;
     /**
-     * @brief moreInfo
+     * @brief moreInfo more information about error
      */
     QString         moreInfo;
 };

exception/vexceptionuniqueid.h

@@ -32,60 +32,60 @@
 #include "vexception.h"
 
 /**
- * @brief The VExceptionUniqueId class
+ * @brief The VExceptionUniqueId class for exception unique id
  */
 class VExceptionUniqueId : public VException
 {
 public:
                     /**
-                     * @brief VExceptionUniqueId
+                     * @brief VExceptionUniqueId exception unique id
-                     * @param what
+                     * @param what string with error
-                     * @param domElement
+                     * @param domElement dom element
                      */
                     VExceptionUniqueId(const QString &what, const QDomElement &domElement);
                     /**
-                     * @brief VExceptionUniqueId
+                     * @brief VExceptionUniqueId copy constructor
-                     * @param e
+                     * @param e exception
                      */
                     VExceptionUniqueId(const VExceptionUniqueId &e)
                         :VException(e), tagText(e.TagText()), tagName(e.TagName()), lineNumber(e.LineNumber()){}
     virtual         ~VExceptionUniqueId() Q_DECL_NOEXCEPT_EXPR(true){}
     /**
-     * @brief ErrorMessage
+     * @brief ErrorMessage return main error message
-     * @return
+     * @return main error message
      */
     virtual QString ErrorMessage() const;
     /**
-     * @brief DetailedInformation
+     * @brief DetailedInformation return detailed information about error
-     * @return
+     * @return detailed information
      */
     virtual QString DetailedInformation() const;
     /**
-     * @brief TagText
+     * @brief TagText return tag text
-     * @return
+     * @return tag text
      */
     inline QString  TagText() const {return tagText;}
     /**
-     * @brief TagName
+     * @brief TagName return tag name
-     * @return
+     * @return tag name
      */
     inline QString  TagName() const {return tagName;}
     /**
-     * @brief LineNumber
+     * @brief LineNumber return line number in file
-     * @return
+     * @return line number
      */
     inline qint32   LineNumber() const {return lineNumber;}
 protected:
     /**
-     * @brief tagText
+     * @brief tagText tag text
      */
     QString         tagText;
     /**
-     * @brief tagName
+     * @brief tagName tag name
      */
     QString         tagName;
     /**
-     * @brief lineNumber
+     * @brief lineNumber line number
      */
     qint32          lineNumber;
 };

exception/vexceptionwrongparameterid.h

@@ -32,60 +32,60 @@
 #include "vexception.h"
 
 /**
- * @brief The VExceptionWrongParameterId class
+ * @brief The VExceptionWrongParameterId class for exception wrong parameter id
  */
 class VExceptionWrongParameterId : public VException
 {
 public:
                     /**
-                     * @brief VExceptionWrongParameterId
+                     * @brief VExceptionWrongParameterId exception wrong parameter id
-                     * @param what
+                     * @param what string with error
-                     * @param domElement
+                     * @param domElement som element
                      */
                     VExceptionWrongParameterId(const QString &what, const QDomElement &domElement);
                     /**
-                     * @brief VExceptionWrongParameterId
+                     * @brief VExceptionWrongParameterId copy constructor
-                     * @param e
+                     * @param e exception
                      */
                     VExceptionWrongParameterId(const VExceptionWrongParameterId &e)
                         :VException(e), tagText(e.TagText()), tagName(e.TagName()), lineNumber(e.LineNumber()){}
     virtual         ~VExceptionWrongParameterId() Q_DECL_NOEXCEPT_EXPR(true){}
     /**
-     * @brief ErrorMessage
+     * @brief ErrorMessage return main error message
-     * @return
+     * @return main error message
      */
     virtual QString ErrorMessage() const;
     /**
-     * @brief DetailedInformation
+     * @brief DetailedInformation return detailed information about error
-     * @return
+     * @return detailed information
      */
     virtual QString DetailedInformation() const;
     /**
-     * @brief TagText
+     * @brief TagText return tag text
-     * @return
+     * @return tag text
      */
     inline QString  TagText() const {return tagText;}
     /**
-     * @brief TagName
+     * @brief TagName return tag name
-     * @return
+     * @return tag name
      */
     inline QString  TagName() const {return tagName;}
     /**
-     * @brief LineNumber
+     * @brief LineNumber return line number in file
-     * @return
+     * @return line number
      */
     inline qint32   LineNumber() const {return lineNumber;}
 protected:
     /**
-     * @brief tagText
+     * @brief tagText tag text
      */
     QString         tagText;
     /**
-     * @brief tagName
+     * @brief tagName tag name
      */
     QString         tagName;
     /**
-     * @brief lineNumber
+     * @brief lineNumber line number
      */
     qint32          lineNumber;
 };