summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorSandro S. Andrade <sandroandrade@kde.org>2013-11-24 00:57:12 -0300
committerSandro S. Andrade <sandroandrade@kde.org>2013-11-24 04:52:33 +0100
commit2086ee4b7b49adc17efcc4809cfa63ef4aa68383 (patch)
tree083b7090f218d5eab8a9572f3ef817546d0df46d /src
parent7b0b553eefaea94f0599d74fbf499703a85fa09b (diff)
Fix templates and QtDuse module documentation
Change-Id: I5d4094fed600afa329728c65c741a10037b79ffe Reviewed-by: Sandro S. Andrade <sandroandrade@kde.org>
Diffstat (limited to 'src')
-rw-r--r--src/duse/doc/qtduse.qdocconf5
-rw-r--r--src/duse/doc/src/qtduse.qdoc4
-rw-r--r--src/duse/qdusedesigndimension.cpp54
-rw-r--r--src/duse/qdusedesigndimension.h4
-rw-r--r--src/duse/qdusedesigndimensioninstance.cpp14
-rw-r--r--src/duse/qdusedesigndimensioninstance.h4
-rw-r--r--src/duse/qdusedesignspace.cpp37
-rw-r--r--src/duse/qdusedesignspace.h4
-rw-r--r--src/duse/qdusemodelchange.cpp30
-rw-r--r--src/duse/qdusemodelchange.h4
-rw-r--r--src/duse/qdusequalitymetric.cpp16
-rw-r--r--src/duse/qdusequalitymetric.h4
-rw-r--r--src/duse/qdusevariationpoint.cpp40
-rw-r--r--src/duse/qdusevariationpoint.h4
-rw-r--r--src/duse/qobjects/qdusedesigndimensioninstanceobject.cpp2
-rw-r--r--src/duse/qobjects/qdusedesigndimensioninstanceobject_p.h4
-rw-r--r--src/duse/qobjects/qdusedesigndimensionobject.cpp2
-rw-r--r--src/duse/qobjects/qdusedesigndimensionobject_p.h4
-rw-r--r--src/duse/qobjects/qdusedesignspaceobject_p.h4
-rw-r--r--src/duse/qobjects/qdusemodelchangeobject.cpp6
-rw-r--r--src/duse/qobjects/qdusemodelchangeobject_p.h4
-rw-r--r--src/duse/qobjects/qdusequalitymetricobject_p.h4
-rw-r--r--src/duse/qobjects/qdusevariationpointobject_p.h4
-rw-r--r--src/duse/qtduseglobal.h3
-rw-r--r--src/duse/qtdusenamespace.h4
-rw-r--r--src/modelingwidgets/doc/qtmodelingwidgets.qdocconf1
26 files changed, 200 insertions, 66 deletions
diff --git a/src/duse/doc/qtduse.qdocconf b/src/duse/doc/qtduse.qdocconf
index fe444e2f..3b723960 100644
--- a/src/duse/doc/qtduse.qdocconf
+++ b/src/duse/doc/qtduse.qdocconf
@@ -26,7 +26,7 @@ qhp.QtDuse.subprojects.classes.selectors = class fake:headerfile
qhp.QtDuse.subprojects.classes.sortPages = true
tagfile = ../../../doc/qtduse/qtduse.tags
-depends += qtcore qtxml qtdoc
+depends += qtcore qtdoc qtmodeling qtuml
headerdirs += ..
@@ -39,3 +39,6 @@ exampledirs += ../../../examples/duse \
imagedirs += images \
../../../examples/duse/doc/images
+
+navigation.landingpage = "Qt Duse"
+navigation.cppclassespage = "Qt Duse C++ Classes"
diff --git a/src/duse/doc/src/qtduse.qdoc b/src/duse/doc/src/qtduse.qdoc
index c50448ff..6cf61436 100644
--- a/src/duse/doc/src/qtduse.qdoc
+++ b/src/duse/doc/src/qtduse.qdoc
@@ -44,13 +44,13 @@
\section1 Reference
These are links to the API reference materials.
\list
- \li \l{Qt Duse Module C++ Classes}{C++ classes}
+ \li \l{Qt Duse C++ Classes}{C++ classes}
\endlist
*/
/*!
\module QtDuse
- \title Qt Duse Module C++ Classes
+ \title Qt Duse C++ Classes
\ingroup modules
\brief Implements the Duse metamodel for domain-independent design spaces representation.
diff --git a/src/duse/qdusedesigndimension.cpp b/src/duse/qdusedesigndimension.cpp
index 49396aa1..7519ec9e 100644
--- a/src/duse/qdusedesigndimension.cpp
+++ b/src/duse/qdusedesigndimension.cpp
@@ -55,6 +55,10 @@ QT_BEGIN_NAMESPACE
\brief A design dimension captures a specific degree of freedom when designing architectures in the given application domain. A design dimension entails a set of variation points which denote alternative solutions for such degree of freedom. Optionally, a variation point may define validation rules which should return a true value if that variation point is to be considered valid for the corresponding input model. A variation point may also specify a set of other variation points which should be previously evaluated, defining a sort of design dimension dependency.
*/
+
+/*!
+ Creates a new QDuseDesignDimension. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true.
+*/
QDuseDesignDimension::QDuseDesignDimension(bool createQModelingObject) :
_instanceSelectionRule(0)
{
@@ -62,6 +66,9 @@ QDuseDesignDimension::QDuseDesignDimension(bool createQModelingObject) :
_qModelingObject = qobject_cast<QModelingObject *>(new QDuseDesignDimensionObject(this));
}
+/*!
+ Returns a deep-copied clone of the QDuseDesignDimension.
+*/
QModelingElement *QDuseDesignDimension::clone() const
{
QDuseDesignDimension *c = new QDuseDesignDimension;
@@ -90,6 +97,9 @@ QString QDuseDesignDimension::name() const
return _name;
}
+/*!
+ Adjusts name to \a name.
+ */
void QDuseDesignDimension::setName(QString name)
{
// This is a read-write property
@@ -109,6 +119,9 @@ QUmlOpaqueExpression *QDuseDesignDimension::instanceSelectionRule() const
return _instanceSelectionRule;
}
+/*!
+ Adjusts instanceSelectionRule to \a instanceSelectionRule.
+ */
void QDuseDesignDimension::setInstanceSelectionRule(QUmlOpaqueExpression *instanceSelectionRule)
{
// This is a read-write property
@@ -123,6 +136,8 @@ void QDuseDesignDimension::setInstanceSelectionRule(QUmlOpaqueExpression *instan
/*!
The design dimensions that must be previously evaluated before this design dimension. Such dependency may be required in order to tackle dependent design dimensions and identify invalid design space locations.
+
+ \sa addRequiredPreviousEvaluation(), removeRequiredPreviousEvaluation()
*/
const QSet<QDuseDesignDimension *> QDuseDesignDimension::requiredPreviousEvaluations() const
{
@@ -131,6 +146,11 @@ const QSet<QDuseDesignDimension *> QDuseDesignDimension::requiredPreviousEvaluat
return _requiredPreviousEvaluations;
}
+/*!
+ Adds \a requiredPreviousEvaluation to requiredPreviousEvaluations.
+
+ \sa requiredPreviousEvaluations(), removeRequiredPreviousEvaluation()
+ */
void QDuseDesignDimension::addRequiredPreviousEvaluation(QDuseDesignDimension *requiredPreviousEvaluation)
{
// This is a read-write property
@@ -142,6 +162,11 @@ void QDuseDesignDimension::addRequiredPreviousEvaluation(QDuseDesignDimension *r
}
}
+/*!
+ Removes \a requiredPreviousEvaluation from requiredPreviousEvaluations.
+
+ \sa requiredPreviousEvaluations(), addRequiredPreviousEvaluation()
+ */
void QDuseDesignDimension::removeRequiredPreviousEvaluation(QDuseDesignDimension *requiredPreviousEvaluation)
{
// This is a read-write property
@@ -153,6 +178,8 @@ void QDuseDesignDimension::removeRequiredPreviousEvaluation(QDuseDesignDimension
/*!
The design dimension's variation points (alternative solutions for the design dimension's concern).
+
+ \sa addVariationPoint(), removeVariationPoint()
*/
const QList<QDuseVariationPoint *> QDuseDesignDimension::variationPoints() const
{
@@ -161,6 +188,11 @@ const QList<QDuseVariationPoint *> QDuseDesignDimension::variationPoints() const
return _variationPoints;
}
+/*!
+ Adds \a variationPoint to variationPoints.
+
+ \sa variationPoints(), removeVariationPoint()
+ */
void QDuseDesignDimension::addVariationPoint(QDuseVariationPoint *variationPoint)
{
// This is a read-write property
@@ -173,6 +205,11 @@ void QDuseDesignDimension::addVariationPoint(QDuseVariationPoint *variationPoint
}
}
+/*!
+ Removes \a variationPoint from variationPoints.
+
+ \sa variationPoints(), addVariationPoint()
+ */
void QDuseDesignDimension::removeVariationPoint(QDuseVariationPoint *variationPoint)
{
// This is a read-write property
@@ -186,6 +223,8 @@ void QDuseDesignDimension::removeVariationPoint(QDuseVariationPoint *variationPo
/*!
A specific design dimension instance created for a identified locus of architectural decision.
+
+ \sa addDesignDimensionInstance(), removeDesignDimensionInstance()
*/
const QSet<QDuseDesignDimensionInstance *> QDuseDesignDimension::designDimensionInstances() const
{
@@ -194,6 +233,11 @@ const QSet<QDuseDesignDimensionInstance *> QDuseDesignDimension::designDimension
return _designDimensionInstances;
}
+/*!
+ Adds \a designDimensionInstance to designDimensionInstances.
+
+ \sa designDimensionInstances(), removeDesignDimensionInstance()
+ */
void QDuseDesignDimension::addDesignDimensionInstance(QDuseDesignDimensionInstance *designDimensionInstance)
{
// This is a read-write property
@@ -206,6 +250,11 @@ void QDuseDesignDimension::addDesignDimensionInstance(QDuseDesignDimensionInstan
}
}
+/*!
+ Removes \a designDimensionInstance from designDimensionInstances.
+
+ \sa designDimensionInstances(), addDesignDimensionInstance()
+ */
void QDuseDesignDimension::removeDesignDimensionInstance(QDuseDesignDimensionInstance *designDimensionInstance)
{
// This is a read-write property
@@ -218,7 +267,7 @@ void QDuseDesignDimension::removeDesignDimensionInstance(QDuseDesignDimensionIns
}
/*!
- Indicates if the design dimension should be considered in automated architecture design.
+ Returns true if the design dimension should be considered in automated architecture design, otherwise returns false.
*/
bool QDuseDesignDimension::enabled() const
{
@@ -227,6 +276,9 @@ bool QDuseDesignDimension::enabled() const
return _enabled;
}
+/*!
+ Adjusts enabled to \a enabled.
+ */
void QDuseDesignDimension::setEnabled(bool enabled)
{
// This is a read-write property
diff --git a/src/duse/qdusedesigndimension.h b/src/duse/qdusedesigndimension.h
index 0561e268..63144779 100644
--- a/src/duse/qdusedesigndimension.h
+++ b/src/duse/qdusedesigndimension.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingElement>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -92,7 +90,5 @@ QT_END_NAMESPACE
Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QDuseDesignDimension) *)
-QT_END_HEADER
-
#endif // QDUSEDESIGNDIMENSION_H
diff --git a/src/duse/qdusedesigndimensioninstance.cpp b/src/duse/qdusedesigndimensioninstance.cpp
index 4bd53fef..53a12889 100644
--- a/src/duse/qdusedesigndimensioninstance.cpp
+++ b/src/duse/qdusedesigndimensioninstance.cpp
@@ -53,6 +53,10 @@ QT_BEGIN_NAMESPACE
\brief A specific design dimenstion instance created to tackle a particular locus of architectural decision in the input model.
*/
+
+/*!
+ Creates a new QDuseDesignDimensionInstance. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true.
+*/
QDuseDesignDimensionInstance::QDuseDesignDimensionInstance(bool createQModelingObject) :
_targetInstance(0)
{
@@ -60,6 +64,9 @@ QDuseDesignDimensionInstance::QDuseDesignDimensionInstance(bool createQModelingO
_qModelingObject = qobject_cast<QModelingObject *>(new QDuseDesignDimensionInstanceObject(this));
}
+/*!
+ Returns a deep-copied clone of the QDuseDesignDimensionInstance.
+*/
QModelingElement *QDuseDesignDimensionInstance::clone() const
{
QDuseDesignDimensionInstance *c = new QDuseDesignDimensionInstance;
@@ -70,7 +77,9 @@ QModelingElement *QDuseDesignDimensionInstance::clone() const
// OWNED ATTRIBUTES
-
+/*!
+ The model element which is the target of architectural changes defined in this design dimension instance.
+ */
QUmlElement *QDuseDesignDimensionInstance::targetInstance() const
{
// This is a read-write property
@@ -78,6 +87,9 @@ QUmlElement *QDuseDesignDimensionInstance::targetInstance() const
return _targetInstance;
}
+/*!
+ Adjusts targetInstance to \a targetInstance.
+ */
void QDuseDesignDimensionInstance::setTargetInstance(QUmlElement *targetInstance)
{
// This is a read-write property
diff --git a/src/duse/qdusedesigndimensioninstance.h b/src/duse/qdusedesigndimensioninstance.h
index b4e3c084..0e9e919d 100644
--- a/src/duse/qdusedesigndimensioninstance.h
+++ b/src/duse/qdusedesigndimensioninstance.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingElement>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -72,7 +70,5 @@ QT_END_NAMESPACE
Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QDuseDesignDimensionInstance) *)
-QT_END_HEADER
-
#endif // QDUSEDESIGNDIMENSIONINSTANCE_H
diff --git a/src/duse/qdusedesignspace.cpp b/src/duse/qdusedesignspace.cpp
index 39fe4c47..229d4962 100644
--- a/src/duse/qdusedesignspace.cpp
+++ b/src/duse/qdusedesignspace.cpp
@@ -54,12 +54,19 @@ QT_BEGIN_NAMESPACE
\brief A design space entails the design dimensions (degrees of freedom) and quality metrics for a particular application domain.
*/
+
+/*!
+ Creates a new QDuseDesignSpace. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true.
+*/
QDuseDesignSpace::QDuseDesignSpace(bool createQModelingObject)
{
if (createQModelingObject)
_qModelingObject = qobject_cast<QModelingObject *>(new QDuseDesignSpaceObject(this));
}
+/*!
+ Returns a deep-copied clone of the QDuseDesignSpace.
+*/
QModelingElement *QDuseDesignSpace::clone() const
{
QDuseDesignSpace *c = new QDuseDesignSpace;
@@ -84,6 +91,9 @@ QString QDuseDesignSpace::name() const
return _name;
}
+/*!
+ Adjusts name to \a name.
+ */
void QDuseDesignSpace::setName(QString name)
{
// This is a read-write property
@@ -103,6 +113,9 @@ QString QDuseDesignSpace::requiredProfile() const
return _requiredProfile;
}
+/*!
+ Adjusts requiredProfile to \a requiredProfile.
+ */
void QDuseDesignSpace::setRequiredProfile(QString requiredProfile)
{
// This is a read-write property
@@ -114,6 +127,8 @@ void QDuseDesignSpace::setRequiredProfile(QString requiredProfile)
/*!
The design dimensions (degrees of freedom) of the design space.
+
+ \sa addDesignDimension(), removeDesignDimension()
*/
const QList<QDuseDesignDimension *> QDuseDesignSpace::designDimensions() const
{
@@ -122,6 +137,11 @@ const QList<QDuseDesignDimension *> QDuseDesignSpace::designDimensions() const
return _designDimensions;
}
+/*!
+ Adds \a designDimension to designDimensions.
+
+ \sa designDimensions(), removeDesignDimension()
+ */
void QDuseDesignSpace::addDesignDimension(QDuseDesignDimension *designDimension)
{
// This is a read-write property
@@ -134,6 +154,11 @@ void QDuseDesignSpace::addDesignDimension(QDuseDesignDimension *designDimension)
}
}
+/*!
+ Removes \a designDimension from designDimensions.
+
+ \sa designDimensions(), addDesignDimension()
+ */
void QDuseDesignSpace::removeDesignDimension(QDuseDesignDimension *designDimension)
{
// This is a read-write property
@@ -147,6 +172,8 @@ void QDuseDesignSpace::removeDesignDimension(QDuseDesignDimension *designDimensi
/*!
The quality metrics defined for the design space.
+
+ \sa addQualityMetric(), removeQualityMetric()
*/
const QSet<QDuseQualityMetric *> QDuseDesignSpace::qualityMetrics() const
{
@@ -155,6 +182,11 @@ const QSet<QDuseQualityMetric *> QDuseDesignSpace::qualityMetrics() const
return _qualityMetrics;
}
+/*!
+ Adds \a qualityMetric to qualityMetrics.
+
+ \sa qualityMetrics(), removeQualityMetric()
+ */
void QDuseDesignSpace::addQualityMetric(QDuseQualityMetric *qualityMetric)
{
// This is a read-write property
@@ -167,6 +199,11 @@ void QDuseDesignSpace::addQualityMetric(QDuseQualityMetric *qualityMetric)
}
}
+/*!
+ Removes \a qualityMetric from qualityMetrics.
+
+ \sa qualityMetrics(), addQualityMetric()
+ */
void QDuseDesignSpace::removeQualityMetric(QDuseQualityMetric *qualityMetric)
{
// This is a read-write property
diff --git a/src/duse/qdusedesignspace.h b/src/duse/qdusedesignspace.h
index 80ba4ed8..87b76b66 100644
--- a/src/duse/qdusedesignspace.h
+++ b/src/duse/qdusedesignspace.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingElement>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -84,7 +82,5 @@ QT_END_NAMESPACE
Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QDuseDesignSpace) *)
-QT_END_HEADER
-
#endif // QDUSEDESIGNSPACE_H
diff --git a/src/duse/qdusemodelchange.cpp b/src/duse/qdusemodelchange.cpp
index a4649b35..91333624 100644
--- a/src/duse/qdusemodelchange.cpp
+++ b/src/duse/qdusemodelchange.cpp
@@ -51,7 +51,13 @@ QT_BEGIN_NAMESPACE
\class QDuseModelChange
\inmodule QtDuse
+
+ \brief The changes to be enacted in the design dimension instance's target element.
*/
+
+/*!
+ Creates a new QDuseModelChange. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true.
+*/
QDuseModelChange::QDuseModelChange(bool createQModelingObject) :
_targetSelectionRule(0),
_valueSelectionRule(0),
@@ -61,6 +67,9 @@ QDuseModelChange::QDuseModelChange(bool createQModelingObject) :
_qModelingObject = qobject_cast<QModelingObject *>(new QDuseModelChangeObject(this));
}
+/*!
+ Returns a deep-copied clone of the QDuseModelChange.
+*/
QModelingElement *QDuseModelChange::clone() const
{
QDuseModelChange *c = new QDuseModelChange;
@@ -75,7 +84,9 @@ QModelingElement *QDuseModelChange::clone() const
// OWNED ATTRIBUTES
-
+/*!
+ A rule to select the element which is the target of this particular change.
+ */
QUmlOpaqueExpression *QDuseModelChange::targetSelectionRule() const
{
// This is a read-write property
@@ -83,6 +94,9 @@ QUmlOpaqueExpression *QDuseModelChange::targetSelectionRule() const
return _targetSelectionRule;
}
+/*!
+ Adjusts targetSelectionRule to \a targetSelectionRule.
+ */
void QDuseModelChange::setTargetSelectionRule(QUmlOpaqueExpression *targetSelectionRule)
{
// This is a read-write property
@@ -95,7 +109,9 @@ void QDuseModelChange::setTargetSelectionRule(QUmlOpaqueExpression *targetSelect
}
}
-
+/*!
+ A rule to find out the new value of this target's property.
+ */
QUmlOpaqueExpression *QDuseModelChange::valueSelectionRule() const
{
// This is a read-write property
@@ -103,6 +119,9 @@ QUmlOpaqueExpression *QDuseModelChange::valueSelectionRule() const
return _valueSelectionRule;
}
+/*!
+ Adjusts valueSelectionRule to \a valueSelectionRule.
+ */
void QDuseModelChange::setValueSelectionRule(QUmlOpaqueExpression *valueSelectionRule)
{
// This is a read-write property
@@ -115,7 +134,9 @@ void QDuseModelChange::setValueSelectionRule(QUmlOpaqueExpression *valueSelectio
}
}
-
+/*!
+ The metamodel's property which will be modified in this change.
+ */
QUmlProperty *QDuseModelChange::targetProperty() const
{
// This is a read-write property
@@ -123,6 +144,9 @@ QUmlProperty *QDuseModelChange::targetProperty() const
return _targetProperty;
}
+/*!
+ Adjusts targetProperty to \a targetProperty.
+ */
void QDuseModelChange::setTargetProperty(QUmlProperty *targetProperty)
{
// This is a read-write property
diff --git a/src/duse/qdusemodelchange.h b/src/duse/qdusemodelchange.h
index cb4d6517..3cd7bf66 100644
--- a/src/duse/qdusemodelchange.h
+++ b/src/duse/qdusemodelchange.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingElement>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -79,7 +77,5 @@ QT_END_NAMESPACE
Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QDuseModelChange) *)
-QT_END_HEADER
-
#endif // QDUSEMODELCHANGE_H
diff --git a/src/duse/qdusequalitymetric.cpp b/src/duse/qdusequalitymetric.cpp
index 841074aa..e3189a70 100644
--- a/src/duse/qdusequalitymetric.cpp
+++ b/src/duse/qdusequalitymetric.cpp
@@ -53,6 +53,10 @@ QT_BEGIN_NAMESPACE
\brief A quality metric defined for the corresponding design space.
*/
+
+/*!
+ Creates a new QDuseQualityMetric. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true.
+*/
QDuseQualityMetric::QDuseQualityMetric(bool createQModelingObject) :
_expression(0)
{
@@ -60,6 +64,9 @@ QDuseQualityMetric::QDuseQualityMetric(bool createQModelingObject) :
_qModelingObject = qobject_cast<QModelingObject *>(new QDuseQualityMetricObject(this));
}
+/*!
+ Returns a deep-copied clone of the QDuseQualityMetric.
+*/
QModelingElement *QDuseQualityMetric::clone() const
{
QDuseQualityMetric *c = new QDuseQualityMetric;
@@ -82,6 +89,9 @@ QString QDuseQualityMetric::name() const
return _name;
}
+/*!
+ Adjusts name to \a name.
+ */
void QDuseQualityMetric::setName(QString name)
{
// This is a read-write property
@@ -101,6 +111,9 @@ double QDuseQualityMetric::value() const
return _value;
}
+/*!
+ Adjusts value to \a value.
+ */
void QDuseQualityMetric::setValue(double value)
{
// This is a read-write property
@@ -120,6 +133,9 @@ QUmlOpaqueExpression *QDuseQualityMetric::expression() const
return _expression;
}
+/*!
+ Adjusts expression to \a expression.
+ */
void QDuseQualityMetric::setExpression(QUmlOpaqueExpression *expression)
{
// This is a read-write property
diff --git a/src/duse/qdusequalitymetric.h b/src/duse/qdusequalitymetric.h
index 21867397..21e6dab0 100644
--- a/src/duse/qdusequalitymetric.h
+++ b/src/duse/qdusequalitymetric.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingElement>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -78,7 +76,5 @@ QT_END_NAMESPACE
Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QDuseQualityMetric) *)
-QT_END_HEADER
-
#endif // QDUSEQUALITYMETRIC_H
diff --git a/src/duse/qdusevariationpoint.cpp b/src/duse/qdusevariationpoint.cpp
index 6b4c8295..6335e600 100644
--- a/src/duse/qdusevariationpoint.cpp
+++ b/src/duse/qdusevariationpoint.cpp
@@ -55,6 +55,10 @@ QT_BEGIN_NAMESPACE
\brief A variation point represents a specific solution for a given design dimension. A variation point entails validation rules which check for valid combinations of variation points and a script which defines the architectural changes to be enacted from such solution.
*/
+
+/*!
+ Creates a new QDuseVariationPoint. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true.
+*/
QDuseVariationPoint::QDuseVariationPoint(bool createQModelingObject) :
_preChangeValidationRule(0)
{
@@ -62,6 +66,9 @@ QDuseVariationPoint::QDuseVariationPoint(bool createQModelingObject) :
_qModelingObject = qobject_cast<QModelingObject *>(new QDuseVariationPointObject(this));
}
+/*!
+ Returns a deep-copied clone of the QDuseVariationPoint.
+*/
QModelingElement *QDuseVariationPoint::clone() const
{
QDuseVariationPoint *c = new QDuseVariationPoint;
@@ -88,6 +95,9 @@ QString QDuseVariationPoint::name() const
return _name;
}
+/*!
+ Adjusts name to \a name.
+ */
void QDuseVariationPoint::setName(QString name)
{
// This is a read-write property
@@ -107,6 +117,9 @@ QString QDuseVariationPoint::rationale() const
return _rationale;
}
+/*!
+ Adjusts rationale to \a rationale.
+ */
void QDuseVariationPoint::setRationale(QString rationale)
{
// This is a read-write property
@@ -126,6 +139,9 @@ QUmlOpaqueExpression *QDuseVariationPoint::preChangeValidationRule() const
return _preChangeValidationRule;
}
+/*!
+ Adjusts preChangeValidationRule to \a preChangeValidationRule.
+ */
void QDuseVariationPoint::setPreChangeValidationRule(QUmlOpaqueExpression *preChangeValidationRule)
{
// This is a read-write property
@@ -140,6 +156,8 @@ void QDuseVariationPoint::setPreChangeValidationRule(QUmlOpaqueExpression *preCh
/*!
The architectural changes to be enacted as contributions arosen from this variation point. The complete set of architectural changes is the merge of architectural contributions from all involved variation points.
+
+ \sa addModelChange(), removeModelChange()
*/
const QList<QDuseModelChange *> QDuseVariationPoint::modelChanges() const
{
@@ -148,6 +166,11 @@ const QList<QDuseModelChange *> QDuseVariationPoint::modelChanges() const
return _modelChanges;
}
+/*!
+ Adds \a modelChange to modelChanges.
+
+ \sa modelChanges(), removeModelChange()
+ */
void QDuseVariationPoint::addModelChange(QDuseModelChange *modelChange)
{
// This is a read-write property
@@ -160,6 +183,11 @@ void QDuseVariationPoint::addModelChange(QDuseModelChange *modelChange)
}
}
+/*!
+ Removes \a modelChange from modelChanges.
+
+ \sa modelChanges(), addModelChange()
+ */
void QDuseVariationPoint::removeModelChange(QDuseModelChange *modelChange)
{
// This is a read-write property
@@ -173,6 +201,8 @@ void QDuseVariationPoint::removeModelChange(QDuseModelChange *modelChange)
/*!
The architectural elements to be added as part of architecture redesign contribution arising from this variation point. The complete set of added architectural elements is the merge of architectural contributions from all involved variation points.
+
+ \sa addAddedElement(), removeAddedElement()
*/
const QList<QUmlElement *> QDuseVariationPoint::addedElements() const
{
@@ -181,6 +211,11 @@ const QList<QUmlElement *> QDuseVariationPoint::addedElements() const
return _addedElements;
}
+/*!
+ Adds \a addedElement to addedElements.
+
+ \sa addedElements(), removeAddedElement()
+ */
void QDuseVariationPoint::addAddedElement(QUmlElement *addedElement)
{
// This is a read-write property
@@ -192,6 +227,11 @@ void QDuseVariationPoint::addAddedElement(QUmlElement *addedElement)
}
}
+/*!
+ Removes \a addedElement from addedElements.
+
+ \sa addedElements(), addAddedElement()
+ */
void QDuseVariationPoint::removeAddedElement(QUmlElement *addedElement)
{
// This is a read-write property
diff --git a/src/duse/qdusevariationpoint.h b/src/duse/qdusevariationpoint.h
index 2b2e0ed7..33536181 100644
--- a/src/duse/qdusevariationpoint.h
+++ b/src/duse/qdusevariationpoint.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingElement>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -88,7 +86,5 @@ QT_END_NAMESPACE
Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QDuseVariationPoint) *)
-QT_END_HEADER
-
#endif // QDUSEVARIATIONPOINT_H
diff --git a/src/duse/qobjects/qdusedesigndimensioninstanceobject.cpp b/src/duse/qobjects/qdusedesigndimensioninstanceobject.cpp
index 1b51efed..6de2245c 100644
--- a/src/duse/qobjects/qdusedesigndimensioninstanceobject.cpp
+++ b/src/duse/qobjects/qdusedesigndimensioninstanceobject.cpp
@@ -91,7 +91,7 @@ void QDuseDesignDimensionInstanceObject::setPropertyData()
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimensionInstance, targetInstance, PropertyTypeRole, QStringLiteral("QUmlElement *"));
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimensionInstance, targetInstance, IsDerivedRole, false);
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimensionInstance, targetInstance, IsDerivedUnionRole, false);
- Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimensionInstance, targetInstance, DocumentationRole, QStringLiteral(""));
+ Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimensionInstance, targetInstance, DocumentationRole, QStringLiteral("The model element which is the target of architectural changes defined in this design dimension instance."));
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimensionInstance, targetInstance, RedefinedPropertiesRole, QStringLiteral(""));
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimensionInstance, targetInstance, SubsettedPropertiesRole, QStringLiteral(""));
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimensionInstance, targetInstance, OppositeEndRole, QStringLiteral(""));
diff --git a/src/duse/qobjects/qdusedesigndimensioninstanceobject_p.h b/src/duse/qobjects/qdusedesigndimensioninstanceobject_p.h
index d4b44336..46e00d86 100644
--- a/src/duse/qobjects/qdusedesigndimensioninstanceobject_p.h
+++ b/src/duse/qobjects/qdusedesigndimensioninstanceobject_p.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingObject>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -85,7 +83,5 @@ protected:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QDUSEDESIGNDIMENSIONINSTANCEOBJECT_H
diff --git a/src/duse/qobjects/qdusedesigndimensionobject.cpp b/src/duse/qobjects/qdusedesigndimensionobject.cpp
index 5c6cd7c6..e496d28d 100644
--- a/src/duse/qobjects/qdusedesigndimensionobject.cpp
+++ b/src/duse/qobjects/qdusedesigndimensionobject.cpp
@@ -230,7 +230,7 @@ void QDuseDesignDimensionObject::setPropertyData()
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimension, enabled, PropertyTypeRole, QStringLiteral("bool"));
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimension, enabled, IsDerivedRole, false);
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimension, enabled, IsDerivedUnionRole, false);
- Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimension, enabled, DocumentationRole, QStringLiteral("Indicates if the design dimension should be considered in automated architecture design."));
+ Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimension, enabled, DocumentationRole, QStringLiteral("Returns true if the design dimension should be considered in automated architecture design, otherwise returns false."));
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimension, enabled, RedefinedPropertiesRole, QStringLiteral(""));
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimension, enabled, SubsettedPropertiesRole, QStringLiteral(""));
Q_DECLARE_METAPROPERTY_INFO(QDuseDesignDimension, enabled, OppositeEndRole, QStringLiteral(""));
diff --git a/src/duse/qobjects/qdusedesigndimensionobject_p.h b/src/duse/qobjects/qdusedesigndimensionobject_p.h
index ca2bc5ec..53c19855 100644
--- a/src/duse/qobjects/qdusedesigndimensionobject_p.h
+++ b/src/duse/qobjects/qdusedesigndimensionobject_p.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingObject>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -108,7 +106,5 @@ protected:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QDUSEDESIGNDIMENSIONOBJECT_H
diff --git a/src/duse/qobjects/qdusedesignspaceobject_p.h b/src/duse/qobjects/qdusedesignspaceobject_p.h
index ebafc52a..b11e7270 100644
--- a/src/duse/qobjects/qdusedesignspaceobject_p.h
+++ b/src/duse/qobjects/qdusedesignspaceobject_p.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingObject>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -99,7 +97,5 @@ protected:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QDUSEDESIGNSPACEOBJECT_H
diff --git a/src/duse/qobjects/qdusemodelchangeobject.cpp b/src/duse/qobjects/qdusemodelchangeobject.cpp
index f1cc48c5..89fb37b9 100644
--- a/src/duse/qobjects/qdusemodelchangeobject.cpp
+++ b/src/duse/qobjects/qdusemodelchangeobject.cpp
@@ -122,7 +122,7 @@ void QDuseModelChangeObject::setPropertyData()
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetSelectionRule, PropertyTypeRole, QStringLiteral("QUmlOpaqueExpression *"));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetSelectionRule, IsDerivedRole, false);
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetSelectionRule, IsDerivedUnionRole, false);
- Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetSelectionRule, DocumentationRole, QStringLiteral(""));
+ Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetSelectionRule, DocumentationRole, QStringLiteral("A rule to select the element which is the target of this particular change."));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetSelectionRule, RedefinedPropertiesRole, QStringLiteral(""));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetSelectionRule, SubsettedPropertiesRole, QStringLiteral(""));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetSelectionRule, OppositeEndRole, QStringLiteral(""));
@@ -132,7 +132,7 @@ void QDuseModelChangeObject::setPropertyData()
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, valueSelectionRule, PropertyTypeRole, QStringLiteral("QUmlOpaqueExpression *"));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, valueSelectionRule, IsDerivedRole, false);
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, valueSelectionRule, IsDerivedUnionRole, false);
- Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, valueSelectionRule, DocumentationRole, QStringLiteral(""));
+ Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, valueSelectionRule, DocumentationRole, QStringLiteral("A rule to find out the new value of this target's property."));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, valueSelectionRule, RedefinedPropertiesRole, QStringLiteral(""));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, valueSelectionRule, SubsettedPropertiesRole, QStringLiteral(""));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, valueSelectionRule, OppositeEndRole, QStringLiteral(""));
@@ -142,7 +142,7 @@ void QDuseModelChangeObject::setPropertyData()
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetProperty, PropertyTypeRole, QStringLiteral("QUmlProperty *"));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetProperty, IsDerivedRole, false);
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetProperty, IsDerivedUnionRole, false);
- Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetProperty, DocumentationRole, QStringLiteral(""));
+ Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetProperty, DocumentationRole, QStringLiteral("The metamodel's property which will be modified in this change."));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetProperty, RedefinedPropertiesRole, QStringLiteral(""));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetProperty, SubsettedPropertiesRole, QStringLiteral(""));
Q_DECLARE_METAPROPERTY_INFO(QDuseModelChange, targetProperty, OppositeEndRole, QStringLiteral(""));
diff --git a/src/duse/qobjects/qdusemodelchangeobject_p.h b/src/duse/qobjects/qdusemodelchangeobject_p.h
index 65fa45a9..411aa6da 100644
--- a/src/duse/qobjects/qdusemodelchangeobject_p.h
+++ b/src/duse/qobjects/qdusemodelchangeobject_p.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingObject>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -93,7 +91,5 @@ protected:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QDUSEMODELCHANGEOBJECT_H
diff --git a/src/duse/qobjects/qdusequalitymetricobject_p.h b/src/duse/qobjects/qdusequalitymetricobject_p.h
index 208e357b..40ae9a61 100644
--- a/src/duse/qobjects/qdusequalitymetricobject_p.h
+++ b/src/duse/qobjects/qdusequalitymetricobject_p.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingObject>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -93,7 +91,5 @@ protected:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QDUSEQUALITYMETRICOBJECT_H
diff --git a/src/duse/qobjects/qdusevariationpointobject_p.h b/src/duse/qobjects/qdusevariationpointobject_p.h
index 0e3f363e..7e49a317 100644
--- a/src/duse/qobjects/qdusevariationpointobject_p.h
+++ b/src/duse/qobjects/qdusevariationpointobject_p.h
@@ -45,8 +45,6 @@
#include <QtModeling/QModelingObject>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -103,7 +101,5 @@ protected:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QDUSEVARIATIONPOINTOBJECT_H
diff --git a/src/duse/qtduseglobal.h b/src/duse/qtduseglobal.h
index 28bd26e4..b39ad15e 100644
--- a/src/duse/qtduseglobal.h
+++ b/src/duse/qtduseglobal.h
@@ -48,6 +48,9 @@
#include <QtCore/QSet>
#include <QtCore/QString>
+Q_DECLARE_METATYPE(QList<QString> *)
+Q_DECLARE_METATYPE(QSet<QString> *)
+
QT_BEGIN_NAMESPACE
#ifndef QT_STATIC
diff --git a/src/duse/qtdusenamespace.h b/src/duse/qtdusenamespace.h
index 5ec1cc8a..4f2eaa38 100644
--- a/src/duse/qtdusenamespace.h
+++ b/src/duse/qtdusenamespace.h
@@ -45,8 +45,6 @@
#include <QtCore/QObject>
-QT_BEGIN_HEADER
-
QT_BEGIN_NAMESPACE
QT_MODULE(QtDuse)
@@ -60,7 +58,5 @@ public:
QT_END_NAMESPACE
-QT_END_HEADER
-
#endif // QTDUSENAMESPACE_H
diff --git a/src/modelingwidgets/doc/qtmodelingwidgets.qdocconf b/src/modelingwidgets/doc/qtmodelingwidgets.qdocconf
index 77c1843a..6aae99fc 100644
--- a/src/modelingwidgets/doc/qtmodelingwidgets.qdocconf
+++ b/src/modelingwidgets/doc/qtmodelingwidgets.qdocconf
@@ -40,6 +40,5 @@ exampledirs += ../../../examples/modelingwidgets \
imagedirs += images \
../../../examples/modelingwidgets/doc/images
-
navigation.landingpage = "Qt Modeling Widgets"
navigation.cppclassespage = "Qt Modeling Widgets C++ Classes"