From 6fb7a99b7f03f36e73b4c6dc237767fc36a4e1b1 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Thu, 18 Jul 2013 10:30:54 +0200 Subject: [PATCH] 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 --- .../qmldesigner/designercore/exceptions/exception.cpp | 8 +++----- .../designercore/exceptions/invalidargumentexception.cpp | 8 +++----- .../designercore/exceptions/invalidmetainfoexception.cpp | 8 +++----- .../exceptions/invalidmodelnodeexception.cpp | 8 +++----- .../exceptions/invalidmodelstateexception.cpp | 8 +++----- .../designercore/exceptions/invalidpropertyexception.cpp | 8 +++----- .../exceptions/invalidqmlsourceexception.cpp | 9 +++------ .../exceptions/invalidreparentingexception.cpp | 8 +++----- .../exceptions/invalidslideindexexception.cpp | 7 ++----- .../exceptions/modificationgroupexception.cpp | 8 +++----- .../designercore/exceptions/removebasestateexception.cpp | 8 +++----- .../designercore/instances/nodeinstanceview.cpp | 6 +++--- 12 files changed, 35 insertions(+), 59 deletions(-) diff --git a/src/plugins/qmldesigner/designercore/exceptions/exception.cpp b/src/plugins/qmldesigner/designercore/exceptions/exception.cpp index 867f4b25751..4c22033961f 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/exception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/exception.cpp @@ -85,11 +85,9 @@ bool Exception::shouldAssert() } /*! -\brief Constructor - -\param line use the __LINE__ macro -\param function use the __FUNCTION__ or the Q_FUNC_INFO macro -\param file use the __FILE__ macro + 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. */ Exception::Exception(int line, const QString &function, diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp index b8c79262ca3..e96420e83da 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp @@ -40,11 +40,9 @@ argument. namespace QmlDesigner { /*! -\brief Constructor - -\param line use the __LINE__ macro -\param function use the __FUNCTION__ or the Q_FUNC_INFO macro -\param file use the __FILE__ macro + 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 + the __FILE__ macro. */ InvalidArgumentException::InvalidArgumentException(int line, const QString &function, diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp index c5a9f1d517c..7053a3c6e5a 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp @@ -39,11 +39,9 @@ info. */ namespace QmlDesigner { /*! -\brief Constructor - -\param line use the __LINE__ macro -\param function use the __FUNCTION__ or the Q_FUNC_INFO macro -\param file use the __FILE__ macro + 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. */ InvalidMetaInfoException::InvalidMetaInfoException(int line, const QString &function, diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp index 10d1d2426b9..2a85a71b284 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp @@ -39,11 +39,9 @@ model node. */ namespace QmlDesigner { /*! -\brief Constructor - -\param line use the __LINE__ macro -\param function use the __FUNCTION__ or the Q_FUNC_INFO macro -\param file use the __FILE__ macro + 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. */ InvalidModelNodeException::InvalidModelNodeException(int line, const QString &function, diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp index 7c02df82d35..1930b377f49 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp @@ -40,11 +40,9 @@ invalid model state. */ namespace QmlDesigner { /*! -\brief Constructor - -\param line use the __LINE__ macro -\param function use the __FUNCTION__ or the Q_FUNC_INFO macro -\param file use the __FILE__ macro + 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. */ InvalidModelStateException::InvalidModelStateException(int line, const QString &function, diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp index 0f6a850dac8..51e61cc6f68 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp @@ -38,11 +38,9 @@ property. */ namespace QmlDesigner { /*! -\brief Constructor - -\param line use the __LINE__ macro -\param function use the __FUNCTION__ or the Q_FUNC_INFO macro -\param file use the __FILE__ macro + 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. */ InvalidPropertyException::InvalidPropertyException(int line, const QString &function, diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp index f309573cc80..af899afe292 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp @@ -38,12 +38,9 @@ source code. */ namespace QmlDesigner { /*! -\brief Constructor - -\param line use the __LINE__ macro -\param function use the __FUNCTION__ or the Q_FUNC_INFO macro -\param file use the __FILE__ macro -\param qmlSource qml source string + 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 + the __FILE__ macro. */ InvalidQmlSourceException::InvalidQmlSourceException(int line, const QString &function, diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp index 8184ff308ff..97fd0474ee6 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp @@ -38,11 +38,9 @@ */ namespace QmlDesigner { /*! -\brief Constructor - -\param line use the __LINE__ macro -\param function use the __FUNCTION__ or the Q_FUNC_INFO macro -\param file use the __FILE__ macro + 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. */ InvalidReparentingException::InvalidReparentingException(int line, const QString &function, diff --git a/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp index 5989866acac..057db79dd53 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp @@ -39,11 +39,8 @@ index for a slide. */ namespace QmlDesigner { /*! -\brief Constructor - -\param line use the __LINE__ macro -\param function use the __FUNCTION__ or the Q_FUNC_INFO macro -\param file use the __FILE__ macro + Constructs an exception. \a line uses the __LINE__ macro, + \a function uses the __FUNCTION__ or the Q_FUNC_INFO macro, and \a file uses */ InvalidSlideIndexException::InvalidSlideIndexException(int line, const QString &function, diff --git a/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp index baa75e07dd6..01ec9752a0c 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp @@ -38,11 +38,9 @@ modification group. */ namespace QmlDesigner { /*! -\brief Constructor - -\param line use the __LINE__ macro -\param function use the __FUNCTION__ or the Q_FUNC_INFO macro -\param file use the __FILE__ macro + 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. */ ModificationGroupException::ModificationGroupException(int line, const QString &function, diff --git a/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp b/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp index d761903aaae..105d93c1cc9 100644 --- a/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp +++ b/src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp @@ -39,11 +39,9 @@ */ namespace QmlDesigner { /*! -\brief Constructor - -\param line use the __LINE__ macro -\param function use the __FUNCTION__ or the Q_FUNC_INFO macro -\param file use the __FILE__ macro + 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. */ RemoveBaseStateException::RemoveBaseStateException(int line, const QString &function, diff --git a/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp b/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp index 6e76c66cff3..759adbbb896 100644 --- a/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp +++ b/src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp @@ -91,12 +91,12 @@ For this purpose this view can be rendered offscreen. 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. -\param Parent of this object. If this parent is d this instance is -d too. \see ~NodeInstanceView setRenderOffScreen */