Commit 574539b5 authored by Leena Miettinen's avatar Leena Miettinen
Browse files

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: default avatarThomas Hartmann <Thomas.Hartmann@digia.com>
parent fed10dde
......@@ -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.
*/
}
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
......@@ -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
{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment