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 <Thomas.Hartmann@digia.com>

src/plugins/qmldesigner/designercore/exceptions/exception.cpp

@@ -118,9 +118,7 @@ Exception::~Exception()
 }
 
 /*!
-\brief Returns the unmangled backtrace of this exception
+    Returns the unmangled backtrace of this exception as a string.
-
-\returns the backtrace 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 optional description of this exception as a string.
-
-\returns the description as 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 where this exception was thrown as an integer.
-
-\returns the line number as 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 where this exception was thrown as a string.
-
-\returns the function name as 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 where this exception was thrown as a string.
-
-\returns the file name as 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 of this exception as a string.
-
-\returns the type as a string
 */
 }

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 of the exception as a string.
-
-\returns the type 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 of the exception as a string.
-
-\returns the argument as a string
 */
 QString InvalidArgumentException::argument() const
 {

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 of this exception as a string.
-
-\returns the type as a string
 */
 QString InvalidMetaInfoException::type() const
 {

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 of this exception as a string.
-
-\returns the type as a string
 */
 QString InvalidModelNodeException::type() const
 {

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 of the exception as a string.
-
-\returns the type as a string
 */
 QString InvalidModelStateException::type() const
 {

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 of this exception as a string.
-
-\returns the type 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 of the property of this exception as a string.
-
-\returns the argument as a string
 */
 QString InvalidPropertyException::argument() const
 {

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 of the exception as a string.
-
-\returns the type as a string
 */
 QString InvalidQmlSourceException::type() const
 {

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 of this exception as a string.
-
-\returns the type as a string
 */
 QString InvalidReparentingException::type() const
 {

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 of the exception as a string.
-
-\returns the type as a string
 */
 QString InvalidSlideIndexException::type() const
 {

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 of the exception as a string.
-
-\returns the type as a string
 */
 QString ModificationGroupException::type() const
 {

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 of this exception as a string.
-
-\returns the type as a string
 */
 QString RemoveBaseStateException::type() const
 {