forked from qt-creator/qt-creator
Doc: replace non-existing \param command with \a
Rewrite the paragraphs to use the common style and proper punctuation. Change-Id: I56fbf5b2e5b9ec5baba8f74783d3b70354900e13 Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
This commit is contained in:
@@ -85,11 +85,9 @@ bool Exception::shouldAssert()
|
|||||||
}
|
}
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\brief Constructor
|
Constructs an exception. \a line uses the __LINE__ macro, \a function uses
|
||||||
|
the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses
|
||||||
\param line use the __LINE__ macro
|
the __FILE__ macro.
|
||||||
\param function use the __FUNCTION__ or the Q_FUNC_INFO macro
|
|
||||||
\param file use the __FILE__ macro
|
|
||||||
*/
|
*/
|
||||||
Exception::Exception(int line,
|
Exception::Exception(int line,
|
||||||
const QString &function,
|
const QString &function,
|
||||||
|
@@ -40,11 +40,9 @@ argument.
|
|||||||
namespace QmlDesigner {
|
namespace QmlDesigner {
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\brief Constructor
|
Constructs the exception for \a argument. \a line uses the __LINE__ macro,
|
||||||
|
\a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses
|
||||||
\param line use the __LINE__ macro
|
the __FILE__ macro.
|
||||||
\param function use the __FUNCTION__ or the Q_FUNC_INFO macro
|
|
||||||
\param file use the __FILE__ macro
|
|
||||||
*/
|
*/
|
||||||
InvalidArgumentException::InvalidArgumentException(int line,
|
InvalidArgumentException::InvalidArgumentException(int line,
|
||||||
const QString &function,
|
const QString &function,
|
||||||
|
@@ -39,11 +39,9 @@ info.
|
|||||||
*/
|
*/
|
||||||
namespace QmlDesigner {
|
namespace QmlDesigner {
|
||||||
/*!
|
/*!
|
||||||
\brief Constructor
|
Constructs an exception. \a line uses the __LINE__ macro,
|
||||||
|
\a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses
|
||||||
\param line use the __LINE__ macro
|
the __FILE__ macro.
|
||||||
\param function use the __FUNCTION__ or the Q_FUNC_INFO macro
|
|
||||||
\param file use the __FILE__ macro
|
|
||||||
*/
|
*/
|
||||||
InvalidMetaInfoException::InvalidMetaInfoException(int line,
|
InvalidMetaInfoException::InvalidMetaInfoException(int line,
|
||||||
const QString &function,
|
const QString &function,
|
||||||
|
@@ -39,11 +39,9 @@ model node.
|
|||||||
*/
|
*/
|
||||||
namespace QmlDesigner {
|
namespace QmlDesigner {
|
||||||
/*!
|
/*!
|
||||||
\brief Constructor
|
Constructs an exception. \a line uses the __LINE__ macro,
|
||||||
|
\a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses
|
||||||
\param line use the __LINE__ macro
|
the __FILE__ macro.
|
||||||
\param function use the __FUNCTION__ or the Q_FUNC_INFO macro
|
|
||||||
\param file use the __FILE__ macro
|
|
||||||
*/
|
*/
|
||||||
InvalidModelNodeException::InvalidModelNodeException(int line,
|
InvalidModelNodeException::InvalidModelNodeException(int line,
|
||||||
const QString &function,
|
const QString &function,
|
||||||
|
@@ -40,11 +40,9 @@ invalid model state.
|
|||||||
*/
|
*/
|
||||||
namespace QmlDesigner {
|
namespace QmlDesigner {
|
||||||
/*!
|
/*!
|
||||||
\brief Constructor
|
Constructs an exception. \a line uses the __LINE__ macro,
|
||||||
|
\a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses
|
||||||
\param line use the __LINE__ macro
|
the __FILE__ macro.
|
||||||
\param function use the __FUNCTION__ or the Q_FUNC_INFO macro
|
|
||||||
\param file use the __FILE__ macro
|
|
||||||
*/
|
*/
|
||||||
InvalidModelStateException::InvalidModelStateException(int line,
|
InvalidModelStateException::InvalidModelStateException(int line,
|
||||||
const QString &function,
|
const QString &function,
|
||||||
|
@@ -38,11 +38,9 @@ property.
|
|||||||
*/
|
*/
|
||||||
namespace QmlDesigner {
|
namespace QmlDesigner {
|
||||||
/*!
|
/*!
|
||||||
\brief Constructor
|
Constructs an exception. \a line uses the __LINE__ macro,
|
||||||
|
\a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses
|
||||||
\param line use the __LINE__ macro
|
the __FILE__ macro.
|
||||||
\param function use the __FUNCTION__ or the Q_FUNC_INFO macro
|
|
||||||
\param file use the __FILE__ macro
|
|
||||||
*/
|
*/
|
||||||
InvalidPropertyException::InvalidPropertyException(int line,
|
InvalidPropertyException::InvalidPropertyException(int line,
|
||||||
const QString &function,
|
const QString &function,
|
||||||
|
@@ -38,12 +38,9 @@ source code.
|
|||||||
*/
|
*/
|
||||||
namespace QmlDesigner {
|
namespace QmlDesigner {
|
||||||
/*!
|
/*!
|
||||||
\brief Constructor
|
Constructs an exception for \qmlSource. \a line uses the __LINE__ macro,
|
||||||
|
\a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses
|
||||||
\param line use the __LINE__ macro
|
the __FILE__ macro.
|
||||||
\param function use the __FUNCTION__ or the Q_FUNC_INFO macro
|
|
||||||
\param file use the __FILE__ macro
|
|
||||||
\param qmlSource qml source string
|
|
||||||
*/
|
*/
|
||||||
InvalidQmlSourceException::InvalidQmlSourceException(int line,
|
InvalidQmlSourceException::InvalidQmlSourceException(int line,
|
||||||
const QString &function,
|
const QString &function,
|
||||||
|
@@ -38,11 +38,9 @@
|
|||||||
*/
|
*/
|
||||||
namespace QmlDesigner {
|
namespace QmlDesigner {
|
||||||
/*!
|
/*!
|
||||||
\brief Constructor
|
Constructs an exception. \a line uses the __LINE__ macro,
|
||||||
|
\a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses
|
||||||
\param line use the __LINE__ macro
|
the __FILE__ macro.
|
||||||
\param function use the __FUNCTION__ or the Q_FUNC_INFO macro
|
|
||||||
\param file use the __FILE__ macro
|
|
||||||
*/
|
*/
|
||||||
InvalidReparentingException::InvalidReparentingException(int line,
|
InvalidReparentingException::InvalidReparentingException(int line,
|
||||||
const QString &function,
|
const QString &function,
|
||||||
|
@@ -39,11 +39,8 @@ index for a slide.
|
|||||||
*/
|
*/
|
||||||
namespace QmlDesigner {
|
namespace QmlDesigner {
|
||||||
/*!
|
/*!
|
||||||
\brief Constructor
|
Constructs an exception. \a line uses the __LINE__ macro,
|
||||||
|
\a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses
|
||||||
\param line use the __LINE__ macro
|
|
||||||
\param function use the __FUNCTION__ or the Q_FUNC_INFO macro
|
|
||||||
\param file use the __FILE__ macro
|
|
||||||
*/
|
*/
|
||||||
InvalidSlideIndexException::InvalidSlideIndexException(int line,
|
InvalidSlideIndexException::InvalidSlideIndexException(int line,
|
||||||
const QString &function,
|
const QString &function,
|
||||||
|
@@ -38,11 +38,9 @@ modification group.
|
|||||||
*/
|
*/
|
||||||
namespace QmlDesigner {
|
namespace QmlDesigner {
|
||||||
/*!
|
/*!
|
||||||
\brief Constructor
|
Constructs an exception. \a line uses the __LINE__ macro,
|
||||||
|
\a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses
|
||||||
\param line use the __LINE__ macro
|
the __FILE__ macro.
|
||||||
\param function use the __FUNCTION__ or the Q_FUNC_INFO macro
|
|
||||||
\param file use the __FILE__ macro
|
|
||||||
*/
|
*/
|
||||||
ModificationGroupException::ModificationGroupException(int line,
|
ModificationGroupException::ModificationGroupException(int line,
|
||||||
const QString &function,
|
const QString &function,
|
||||||
|
@@ -39,11 +39,9 @@
|
|||||||
*/
|
*/
|
||||||
namespace QmlDesigner {
|
namespace QmlDesigner {
|
||||||
/*!
|
/*!
|
||||||
\brief Constructor
|
Constructs an exception. \a line uses the __LINE__ macro,
|
||||||
|
\a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses
|
||||||
\param line use the __LINE__ macro
|
the __FILE__ macro.
|
||||||
\param function use the __FUNCTION__ or the Q_FUNC_INFO macro
|
|
||||||
\param file use the __FILE__ macro
|
|
||||||
*/
|
*/
|
||||||
RemoveBaseStateException::RemoveBaseStateException(int line,
|
RemoveBaseStateException::RemoveBaseStateException(int line,
|
||||||
const QString &function,
|
const QString &function,
|
||||||
|
@@ -91,12 +91,12 @@ For this purpose this view can be rendered offscreen.
|
|||||||
|
|
||||||
namespace QmlDesigner {
|
namespace QmlDesigner {
|
||||||
|
|
||||||
/*! \brief Constructor
|
/*!
|
||||||
|
Constructs a node instance view object as a child of \a parent. If \a parent
|
||||||
|
is destructed, this instance is destructed, too.
|
||||||
|
|
||||||
The class will be rendered offscreen if not set otherwise.
|
The class will be rendered offscreen if not set otherwise.
|
||||||
|
|
||||||
\param Parent of this object. If this parent is d this instance is
|
|
||||||
d too.
|
|
||||||
|
|
||||||
\see ~NodeInstanceView setRenderOffScreen
|
\see ~NodeInstanceView setRenderOffScreen
|
||||||
*/
|
*/
|
||||||
|
Reference in New Issue
Block a user