diff --git a/exception/vexception.h b/exception/vexception.h index 1e8e355b6..50be5067e 100644 --- a/exception/vexception.h +++ b/exception/vexception.h @@ -33,49 +33,49 @@ #include /** - * @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 - * @param what + * @brief VException constructor exception + * @param what string with error */ VException(const QString &what); /** - * @brief VException - * @param e + * @brief VException copy constructor + * @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 - * @return + * @brief clone clone exception + * @return new exception */ inline VException *clone() const { return new VException(*this); } /** - * @brief ErrorMessage - * @return + * @brief ErrorMessage return main error message + * @return error message */ virtual QString ErrorMessage() const; /** - * @brief DetailedInformation - * @return + * @brief DetailedInformation return detailed information about error + * @return detailed information */ virtual QString DetailedInformation() const { return QString(); } /** - * @brief What - * @return + * @brief What return string with error + * @return string with error */ inline QString What() const {return what;} protected: /** - * @brief what + * @brief what string with error */ QString what; }; diff --git a/exception/vexceptionbadid.h b/exception/vexceptionbadid.h index 356ca02f3..7facb2bc6 100644 --- a/exception/vexceptionbadid.h +++ b/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 - * @param what - * @param id + * @brief VExceptionBadId exception bad id + * @param what string with error + * @param id id */ VExceptionBadId(const QString &what, const qint64 &id) :VException(what), id(id), key(QString()){} /** - * @brief VExceptionBadId - * @param what - * @param key + * @brief VExceptionBadId exception bad id + * @param what string with error + * @param key string key */ VExceptionBadId(const QString &what, const QString &key) :VException(what), id(0), key(key){} /** - * @brief VExceptionBadId - * @param e + * @brief VExceptionBadId copy constructor + * @param e exception */ VExceptionBadId(const VExceptionBadId &e) :VException(e), id(e.BadId()), key(e.BadKey()){} virtual ~VExceptionBadId() Q_DECL_NOEXCEPT_EXPR(true){} /** - * @brief ErrorMessage - * @return + * @brief ErrorMessage return main error message + * @return main error message */ virtual QString ErrorMessage() const; /** - * @brief BadId - * @return + * @brief BadId return bad id + * @return id */ inline qint64 BadId() const {return id; } /** - * @brief BadKey - * @return + * @brief BadKey return bad key + * @return key */ inline QString BadKey() const {return key; } protected: /** - * @brief id + * @brief id id */ qint64 id; /** - * @brief key + * @brief key key */ QString key; }; diff --git a/exception/vexceptionconversionerror.h b/exception/vexceptionconversionerror.h index 53678f4c1..6af726bf1 100644 --- a/exception/vexceptionconversionerror.h +++ b/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 - * @param what - * @param str + * @brief VExceptionConversionError exception conversion error + * @param what string with error + * @param str string, where happend error */ VExceptionConversionError(const QString &what, const QString &str); /** - * @brief VExceptionConversionError - * @param e + * @brief VExceptionConversionError copy constructor + * @param e exception */ VExceptionConversionError(const VExceptionConversionError &e) :VException(e), str(e.String()){} virtual ~VExceptionConversionError() Q_DECL_NOEXCEPT_EXPR(true) {} /** - * @brief ErrorMessage - * @return + * @brief ErrorMessage return main error message + * @return main error message */ virtual QString ErrorMessage() const; /** - * @brief String - * @return + * @brief String return string, where happend error + * @return string */ inline QString String() const {return str;} protected: /** - * @brief str + * @brief str string, where happend error */ QString str; }; diff --git a/exception/vexceptionemptyparameter.h b/exception/vexceptionemptyparameter.h index bcdb5b296..042c89e40 100644 --- a/exception/vexceptionemptyparameter.h +++ b/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 - * @param what - * @param name - * @param domElement + * @brief VExceptionEmptyParameter exception empty parameter + * @param what string with error + * @param name name of attribute where error + * @param domElement dom element */ VExceptionEmptyParameter(const QString &what, const QString &name, const QDomElement &domElement); /** - * @brief VExceptionEmptyParameter - * @param e + * @brief VExceptionEmptyParameter copy constructor + * @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 - * @return + * @brief ErrorMessage return main error message + * @return main error message */ virtual QString ErrorMessage() const; /** - * @brief DetailedInformation - * @return + * @brief DetailedInformation return detailed information about error + * @return detailed information */ virtual QString DetailedInformation() const; /** - * @brief Name - * @return + * @brief Name return name of attribute where error + * @return name */ inline QString Name() const {return name;} /** - * @brief TagText - * @return + * @brief TagText return tag text + * @return tag text */ inline QString TagText() const {return tagText;} /** - * @brief TagName - * @return + * @brief TagName return tag name + * @return tag name */ inline QString TagName() const {return tagName;} /** - * @brief LineNumber - * @return + * @brief LineNumber return line number of tag + * @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; }; diff --git a/exception/vexceptionobjecterror.h b/exception/vexceptionobjecterror.h index 620f4d189..d1315596e 100644 --- a/exception/vexceptionobjecterror.h +++ b/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 - * @param what - * @param domElement + * @brief VExceptionObjectError exception object error + * @param what string with error + * @param domElement dom element */ VExceptionObjectError(const QString &what, const QDomElement &domElement); /** - * @brief VExceptionObjectError - * @param e + * @brief VExceptionObjectError copy constructor + * @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 - * @return + * @brief ErrorMessage return main error message + * @return main error message */ virtual QString ErrorMessage() const; /** - * @brief DetailedInformation - * @return + * @brief DetailedInformation return detailed information about error + * @return detailed information */ virtual QString DetailedInformation() const; /** - * @brief TagText - * @return + * @brief TagText return tag text + * @return tag text */ inline QString TagText() const {return tagText;} /** - * @brief TagName - * @return + * @brief TagName return tag name + * @return tag name */ inline QString TagName() const {return tagName;} /** - * @brief LineNumber - * @return + * @brief LineNumber return line number in file + * @return line number */ inline qint32 LineNumber() const {return lineNumber;} /** - * @brief AddMoreInformation - * @param info + * @brief AddMoreInformation add more information for error + * @param info information */ void AddMoreInformation(const QString &info); /** - * @brief MoreInformation - * @return + * @brief MoreInformation return more information for error + * @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; }; diff --git a/exception/vexceptionuniqueid.h b/exception/vexceptionuniqueid.h index 397935954..a1bb053ce 100644 --- a/exception/vexceptionuniqueid.h +++ b/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 - * @param what - * @param domElement + * @brief VExceptionUniqueId exception unique id + * @param what string with error + * @param domElement dom element */ VExceptionUniqueId(const QString &what, const QDomElement &domElement); /** - * @brief VExceptionUniqueId - * @param e + * @brief VExceptionUniqueId copy constructor + * @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 - * @return + * @brief ErrorMessage return main error message + * @return main error message */ virtual QString ErrorMessage() const; /** - * @brief DetailedInformation - * @return + * @brief DetailedInformation return detailed information about error + * @return detailed information */ virtual QString DetailedInformation() const; /** - * @brief TagText - * @return + * @brief TagText return tag text + * @return tag text */ inline QString TagText() const {return tagText;} /** - * @brief TagName - * @return + * @brief TagName return tag name + * @return tag name */ inline QString TagName() const {return tagName;} /** - * @brief LineNumber - * @return + * @brief LineNumber return line number in file + * @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; }; diff --git a/exception/vexceptionwrongparameterid.h b/exception/vexceptionwrongparameterid.h index 726785a56..0f9d55383 100644 --- a/exception/vexceptionwrongparameterid.h +++ b/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 - * @param what - * @param domElement + * @brief VExceptionWrongParameterId exception wrong parameter id + * @param what string with error + * @param domElement som element */ VExceptionWrongParameterId(const QString &what, const QDomElement &domElement); /** - * @brief VExceptionWrongParameterId - * @param e + * @brief VExceptionWrongParameterId copy constructor + * @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 - * @return + * @brief ErrorMessage return main error message + * @return main error message */ virtual QString ErrorMessage() const; /** - * @brief DetailedInformation - * @return + * @brief DetailedInformation return detailed information about error + * @return detailed information */ virtual QString DetailedInformation() const; /** - * @brief TagText - * @return + * @brief TagText return tag text + * @return tag text */ inline QString TagText() const {return tagText;} /** - * @brief TagName - * @return + * @brief TagName return tag name + * @return tag name */ inline QString TagName() const {return tagName;} /** - * @brief LineNumber - * @return + * @brief LineNumber return line number in file + * @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; };