From 574539b529a8296625453d95f45a5ff5ef7fd386 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 9 Sep 2013 16:42:11 +0200 Subject: [PATCH] Doc: edit qmldesigner designercore exceptions API docs Do not use the \returns command as it does not exist. Do not use the \arg command (use \a instead). Do not use the \see command (use \sa instead). Remove \brief command from function descriptions for consistency (as it is optional). Fix punctuation, style, and grammar issues. Change-Id: I10d18ef05d4116730796f4d003010d78b44a6138 Reviewed-by: Thomas Hartmann --- .../designercore/exceptions/exception.cpp | 24 +++++-------------- .../exceptions/invalidargumentexception.cpp | 8 ++----- .../exceptions/invalidmetainfoexception.cpp | 4 +--- .../exceptions/invalidmodelnodeexception.cpp | 4 +--- .../exceptions/invalidmodelstateexception.cpp | 4 +--- .../exceptions/invalidpropertyexception.cpp | 8 ++----- .../exceptions/invalidqmlsourceexception.cpp | 4 +--- .../invalidreparentingexception.cpp | 4 +--- .../exceptions/invalidslideindexexception.cpp | 5 ++-- .../exceptions/modificationgroupexception.cpp | 4 +--- .../exceptions/removebasestateexception.cpp | 4 +--- 11 files changed, 19 insertions(+), 54 deletions(-) diff --git a/src/plugins/qmldesigner/designercore/exceptions/exception.cpp b/src/plugins/qmldesigner/designercore/exceptions/exception.cpp index 4c22033961f..1076f181746 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/exception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/exception.cpp @@ -118,9 +118,7 @@ Exception::~Exception() } /*! -\brief Returns the unmangled backtrace of this exception - -\returns the backtrace as a string + Returns the unmangled backtrace of this exception as a string. */ QString Exception::backTrace() const { @@ -128,9 +126,7 @@ QString Exception::backTrace() const } /*! -\brief Returns the optional description of this exception - -\returns the description as string + Returns the optional description of this exception as a string. */ QString Exception::description() const { @@ -138,9 +134,7 @@ QString Exception::description() const } /*! -\brief Returns the line number where this exception was thrown - -\returns the line number as integer + Returns the line number where this exception was thrown as an integer. */ int Exception::line() const { @@ -148,9 +142,7 @@ int Exception::line() const } /*! -\brief Returns the function name where this exception was thrown - -\returns the function name as string + Returns the function name where this exception was thrown as a string. */ QString Exception::function() const { @@ -158,9 +150,7 @@ QString Exception::function() const } /*! -\brief Returns the file name where this exception was thrown - -\returns the file name as string + Returns the file name where this exception was thrown as a string. */ QString Exception::file() const { @@ -184,8 +174,6 @@ QDebug operator<<(QDebug debug, const Exception &exception) /*! \fn QString Exception::type() const -\brief Returns the type of this exception - -\returns the type as a string +Returns the type of this exception as a string. */ } diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp index e96420e83da..6ce15aa9e31 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp @@ -62,9 +62,7 @@ QString InvalidArgumentException::description() const } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of the exception as a string. */ QString InvalidArgumentException::type() const { @@ -72,9 +70,7 @@ QString InvalidArgumentException::type() const } /*! -\brief Returns the argument of this exception - -\returns the argument as a string + Returns the argument of the exception as a string. */ QString InvalidArgumentException::argument() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp index 7053a3c6e5a..9d207b91d8a 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp @@ -51,9 +51,7 @@ InvalidMetaInfoException::InvalidMetaInfoException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of this exception as a string. */ QString InvalidMetaInfoException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp index 2a85a71b284..058ff197f39 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp @@ -51,9 +51,7 @@ InvalidModelNodeException::InvalidModelNodeException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of this exception as a string. */ QString InvalidModelNodeException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp index 1930b377f49..114379472f6 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp @@ -52,9 +52,7 @@ InvalidModelStateException::InvalidModelStateException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of the exception as a string. */ QString InvalidModelStateException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp index 51e61cc6f68..3f33734c63b 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp @@ -51,9 +51,7 @@ InvalidPropertyException::InvalidPropertyException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of this exception as a string. */ QString InvalidPropertyException::type() const { @@ -61,9 +59,7 @@ QString InvalidPropertyException::type() const } /*! -\brief Returns the argument of the property of this exception - -\returns the argument as a string + Returns the argument of the property of this exception as a string. */ QString InvalidPropertyException::argument() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp index af899afe292..acdecda0423 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp @@ -52,9 +52,7 @@ InvalidQmlSourceException::InvalidQmlSourceException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of the exception as a string. */ QString InvalidQmlSourceException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp index 97fd0474ee6..3ba27caa90e 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp @@ -50,9 +50,7 @@ InvalidReparentingException::InvalidReparentingException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string +Returns the type of this exception as a string. */ QString InvalidReparentingException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp index 057db79dd53..c0fa1ee9b94 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp @@ -41,6 +41,7 @@ namespace QmlDesigner { /*! Constructs an exception. \a line uses the __LINE__ macro, \a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses + the __FILE__ macro. */ InvalidSlideIndexException::InvalidSlideIndexException(int line, const QString &function, @@ -50,9 +51,7 @@ InvalidSlideIndexException::InvalidSlideIndexException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of the exception as a string. */ QString InvalidSlideIndexException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp index 01ec9752a0c..3d7f935d0c0 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp @@ -50,9 +50,7 @@ ModificationGroupException::ModificationGroupException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string + Returns the type of the exception as a string. */ QString ModificationGroupException::type() const { diff --git a/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp index 105d93c1cc9..436ba7943c0 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp @@ -51,9 +51,7 @@ RemoveBaseStateException::RemoveBaseStateException(int line, } /*! -\brief Returns the type of this exception - -\returns the type as a string +Returns the type of this exception as a string. */ QString RemoveBaseStateException::type() const {