diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-10 12:43:43 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-10 17:05:12 +0200 |
| commit | 4f07bd688a1fdbccb3598d3e894b2c876dbb9c0f (patch) | |
| tree | 5acfe919632fa94f428177e8a0de419f08dbf9ce /src/plugins/qmldesigner/designercore/model/abstractproperty.cpp | |
| parent | 06ba109c0b72a6ff3d1a0540760720182db24baf (diff) | |
| download | qt-creator-4f07bd688a1fdbccb3598d3e894b2c876dbb9c0f.tar.gz | |
Doc: edit qmldesigner designercore model 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).
Do not use the \name command (could use \ingroup, instead)
Remove \brief command from function descriptions for
consistency (as it is optional).
Fix punctuation, grammar, and style issues.
Remove obsolete documentation and fix function signatures.
Change-Id: I0bff8c00aefdcff451b2d1cefe8b99407bfb4222
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
Diffstat (limited to 'src/plugins/qmldesigner/designercore/model/abstractproperty.cpp')
| -rw-r--r-- | src/plugins/qmldesigner/designercore/model/abstractproperty.cpp | 25 |
1 files changed, 12 insertions, 13 deletions
diff --git a/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp b/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp index 67cc807d8d..267d01d716 100644 --- a/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp +++ b/src/plugins/qmldesigner/designercore/model/abstractproperty.cpp @@ -120,10 +120,9 @@ AbstractView *AbstractProperty::view() const } /*! - \brief AbstractProperty is a value holder for a property - \return the value of the property + Holds a value for a property. Returns the value of the property. - The QVariant is null if the property doesn't exists. + The QVariant is null if the property does not exist. */ PropertyName AbstractProperty::name() const { @@ -135,13 +134,13 @@ PropertyName AbstractProperty::name() const } /*! - \brief Checks if the property is valid. + Checks if the property is valid. - A prooperty is valid if the belonging ModelNode + A property is valid if the belonging model node is valid. This function is not overloaded for subclasses. - \return the property is valid for true return value + Returns whether the property is valid for the \c true return value. */ bool AbstractProperty::isValid() const { @@ -206,8 +205,7 @@ bool AbstractProperty::isValid() const //} /*! - \brief returns the ModelNode to which the property belongs - \return node to which the property belongs + Returns the model node to which the property belongs. */ ModelNode AbstractProperty::parentModelNode() const { @@ -215,15 +213,14 @@ ModelNode AbstractProperty::parentModelNode() const } /*! -\brief returns the QmlObjectNode to which the property belongs -\return node to which the property belongs + Returns the QmlObjectNode to which the property belongs. */ QmlObjectNode AbstractProperty::parentQmlObjectNode() const { return QmlObjectNode(parentModelNode()); } /*! - \brief returns whether the property is the default property for the model node. + Returns whether the property is the default property for the model node. */ bool AbstractProperty::isDefaultProperty() const { @@ -404,7 +401,8 @@ TypeName AbstractProperty::dynamicTypeName() const } /*! - \brief Returns if the the two property handles reference the same property in the same node + Returns whether \a property1 and \a property2 reference the same property in + the same node. */ bool operator ==(const AbstractProperty &property1, const AbstractProperty &property2) { @@ -414,7 +412,8 @@ bool operator ==(const AbstractProperty &property1, const AbstractProperty &prop } /*! - \brief Returns if the the two property handles do not reference the same property in the same node + Returns whether \a property1 and \a property2 do not reference the same + property in the same node. */ bool operator !=(const AbstractProperty &property1, const AbstractProperty &property2) { |