feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: replace non-existing \param command with \a

Browse Source 
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:
Leena Miettinen
2013-07-18 10:30:54 +02:00
parent b64b4431c2
commit 6fb7a99b7f
12 changed files with 35 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/plugins/qmldesigner/designercore/exceptions/exception.cpp
View File

@@ -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,

8
src/plugins/qmldesigner/designercore/exceptions/invalidargumentexception.cpp
View File

@@ -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,

8
src/plugins/qmldesigner/designercore/exceptions/invalidmetainfoexception.cpp
View File

@@ -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,

8
src/plugins/qmldesigner/designercore/exceptions/invalidmodelnodeexception.cpp
View File

@@ -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,

8
src/plugins/qmldesigner/designercore/exceptions/invalidmodelstateexception.cpp
View File

@@ -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,

8
src/plugins/qmldesigner/designercore/exceptions/invalidpropertyexception.cpp
View File

@@ -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,

9
src/plugins/qmldesigner/designercore/exceptions/invalidqmlsourceexception.cpp
View File

@@ -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,

8
src/plugins/qmldesigner/designercore/exceptions/invalidreparentingexception.cpp
View File

@@ -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,

7
src/plugins/qmldesigner/designercore/exceptions/invalidslideindexexception.cpp
View File

@@ -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,

8
src/plugins/qmldesigner/designercore/exceptions/modificationgroupexception.cpp
View File

@@ -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,

8
src/plugins/qmldesigner/designercore/exceptions/removebasestateexception.cpp
View File

@@ -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,

6
src/plugins/qmldesigner/designercore/instances/nodeinstanceview.cpp
View File

@@ -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
*/