diff options
| author | Sandro S. Andrade <sandroandrade@kde.org> | 2013-11-24 12:13:48 -0300 |
|---|---|---|
| committer | Sandro S. Andrade <sandroandrade@kde.org> | 2013-11-24 16:09:14 +0100 |
| commit | 127ae727775358ea6d6a1e292f9bf5714adcd046 (patch) | |
| tree | e77622182ac0a094696f4f608580eaaec7782064 | |
| parent | 1b2df2c79004e93a5bab937d9cac32f7621a6c0e (diff) | |
Update UML metamodel implementation and documentation
Change-Id: I45eccac45a154f94471aa4a55a9562fbc15b2567
Reviewed-by: Sandro S. Andrade <sandroandrade@kde.org>
678 files changed, 6980 insertions, 1751 deletions
diff --git a/src/uml/qobjects/qumlabstractionobject_p.h b/src/uml/qobjects/qumlabstractionobject_p.h index 9a8c57f0..81979d0d 100644 --- a/src/uml/qobjects/qumlabstractionobject_p.h +++ b/src/uml/qobjects/qumlabstractionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -230,7 +228,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLABSTRACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlacceptcallactionobject_p.h b/src/uml/qobjects/qumlacceptcallactionobject_p.h index 04d6fe7d..93225255 100644 --- a/src/uml/qobjects/qumlacceptcallactionobject_p.h +++ b/src/uml/qobjects/qumlacceptcallactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -298,7 +296,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLACCEPTCALLACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlaccepteventactionobject_p.h b/src/uml/qobjects/qumlaccepteventactionobject_p.h index df9b0a82..18b09471 100644 --- a/src/uml/qobjects/qumlaccepteventactionobject_p.h +++ b/src/uml/qobjects/qumlaccepteventactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -286,7 +284,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLACCEPTEVENTACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlactionexecutionspecificationobject_p.h b/src/uml/qobjects/qumlactionexecutionspecificationobject_p.h index aa17b5b4..8c60ba82 100644 --- a/src/uml/qobjects/qumlactionexecutionspecificationobject_p.h +++ b/src/uml/qobjects/qumlactionexecutionspecificationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -194,7 +192,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLACTIONEXECUTIONSPECIFICATIONOBJECT_H diff --git a/src/uml/qobjects/qumlactioninputpinobject_p.h b/src/uml/qobjects/qumlactioninputpinobject_p.h index 92cd23a8..a9087430 100644 --- a/src/uml/qobjects/qumlactioninputpinobject_p.h +++ b/src/uml/qobjects/qumlactioninputpinobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -326,7 +324,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLACTIONINPUTPINOBJECT_H diff --git a/src/uml/qobjects/qumlactivityfinalnodeobject_p.h b/src/uml/qobjects/qumlactivityfinalnodeobject_p.h index 28054f9c..c315d5db 100644 --- a/src/uml/qobjects/qumlactivityfinalnodeobject_p.h +++ b/src/uml/qobjects/qumlactivityfinalnodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -213,7 +211,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLACTIVITYFINALNODEOBJECT_H diff --git a/src/uml/qobjects/qumlactivityobject_p.h b/src/uml/qobjects/qumlactivityobject_p.h index 4d3319ab..b22e7087 100644 --- a/src/uml/qobjects/qumlactivityobject_p.h +++ b/src/uml/qobjects/qumlactivityobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -554,7 +552,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLACTIVITYOBJECT_H diff --git a/src/uml/qobjects/qumlactivityparameternodeobject_p.h b/src/uml/qobjects/qumlactivityparameternodeobject_p.h index 3c08006e..414b018c 100644 --- a/src/uml/qobjects/qumlactivityparameternodeobject_p.h +++ b/src/uml/qobjects/qumlactivityparameternodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -268,7 +266,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLACTIVITYPARAMETERNODEOBJECT_H diff --git a/src/uml/qobjects/qumlactivitypartitionobject_p.h b/src/uml/qobjects/qumlactivitypartitionobject_p.h index 56db0cec..4029dd00 100644 --- a/src/uml/qobjects/qumlactivitypartitionobject_p.h +++ b/src/uml/qobjects/qumlactivitypartitionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -212,7 +210,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLACTIVITYPARTITIONOBJECT_H diff --git a/src/uml/qobjects/qumlactorobject_p.h b/src/uml/qobjects/qumlactorobject_p.h index b26feb37..564484e5 100644 --- a/src/uml/qobjects/qumlactorobject_p.h +++ b/src/uml/qobjects/qumlactorobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -384,7 +382,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLACTOROBJECT_H diff --git a/src/uml/qobjects/qumladdstructuralfeaturevalueactionobject_p.h b/src/uml/qobjects/qumladdstructuralfeaturevalueactionobject_p.h index 50c0fedd..a3e08a24 100644 --- a/src/uml/qobjects/qumladdstructuralfeaturevalueactionobject_p.h +++ b/src/uml/qobjects/qumladdstructuralfeaturevalueactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -312,7 +310,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLADDSTRUCTURALFEATUREVALUEACTIONOBJECT_H diff --git a/src/uml/qobjects/qumladdvariablevalueactionobject_p.h b/src/uml/qobjects/qumladdvariablevalueactionobject_p.h index 8ba577d7..52b29fdd 100644 --- a/src/uml/qobjects/qumladdvariablevalueactionobject_p.h +++ b/src/uml/qobjects/qumladdvariablevalueactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -304,7 +302,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLADDVARIABLEVALUEACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlanyreceiveeventobject_p.h b/src/uml/qobjects/qumlanyreceiveeventobject_p.h index 37612fff..81f62fef 100644 --- a/src/uml/qobjects/qumlanyreceiveeventobject_p.h +++ b/src/uml/qobjects/qumlanyreceiveeventobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -169,7 +167,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLANYRECEIVEEVENTOBJECT_H diff --git a/src/uml/qobjects/qumlartifactobject_p.h b/src/uml/qobjects/qumlartifactobject_p.h index 7d84408d..c037ab51 100644 --- a/src/uml/qobjects/qumlartifactobject_p.h +++ b/src/uml/qobjects/qumlartifactobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -394,7 +392,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLARTIFACTOBJECT_H diff --git a/src/uml/qobjects/qumlassociationclassobject_p.h b/src/uml/qobjects/qumlassociationclassobject_p.h index 6325d57d..eaf24e59 100644 --- a/src/uml/qobjects/qumlassociationclassobject_p.h +++ b/src/uml/qobjects/qumlassociationclassobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -506,7 +504,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLASSOCIATIONCLASSOBJECT_H diff --git a/src/uml/qobjects/qumlassociationobject_p.h b/src/uml/qobjects/qumlassociationobject_p.h index 944b4e9a..424206de 100644 --- a/src/uml/qobjects/qumlassociationobject_p.h +++ b/src/uml/qobjects/qumlassociationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -408,7 +406,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLASSOCIATIONOBJECT_H diff --git a/src/uml/qobjects/qumlbehaviorexecutionspecificationobject_p.h b/src/uml/qobjects/qumlbehaviorexecutionspecificationobject_p.h index 46686a52..fa758167 100644 --- a/src/uml/qobjects/qumlbehaviorexecutionspecificationobject_p.h +++ b/src/uml/qobjects/qumlbehaviorexecutionspecificationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -194,7 +192,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLBEHAVIOREXECUTIONSPECIFICATIONOBJECT_H diff --git a/src/uml/qobjects/qumlbroadcastsignalactionobject_p.h b/src/uml/qobjects/qumlbroadcastsignalactionobject_p.h index 0595f488..0a70a0c9 100644 --- a/src/uml/qobjects/qumlbroadcastsignalactionobject_p.h +++ b/src/uml/qobjects/qumlbroadcastsignalactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -292,7 +290,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLBROADCASTSIGNALACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlcallbehavioractionobject_p.h b/src/uml/qobjects/qumlcallbehavioractionobject_p.h index b76c83a4..83230565 100644 --- a/src/uml/qobjects/qumlcallbehavioractionobject_p.h +++ b/src/uml/qobjects/qumlcallbehavioractionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -310,7 +308,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCALLBEHAVIORACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlcalleventobject_p.h b/src/uml/qobjects/qumlcalleventobject_p.h index f9355754..64b6d974 100644 --- a/src/uml/qobjects/qumlcalleventobject_p.h +++ b/src/uml/qobjects/qumlcalleventobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -181,7 +179,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCALLEVENTOBJECT_H diff --git a/src/uml/qobjects/qumlcalloperationactionobject_p.h b/src/uml/qobjects/qumlcalloperationactionobject_p.h index 3ccbcb1c..9317a4b7 100644 --- a/src/uml/qobjects/qumlcalloperationactionobject_p.h +++ b/src/uml/qobjects/qumlcalloperationactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -314,7 +312,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCALLOPERATIONACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlcentralbuffernodeobject_p.h b/src/uml/qobjects/qumlcentralbuffernodeobject_p.h index 2799041e..fa0b9406 100644 --- a/src/uml/qobjects/qumlcentralbuffernodeobject_p.h +++ b/src/uml/qobjects/qumlcentralbuffernodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -256,7 +254,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCENTRALBUFFERNODEOBJECT_H diff --git a/src/uml/qobjects/qumlchangeeventobject_p.h b/src/uml/qobjects/qumlchangeeventobject_p.h index e5d10744..5102d39a 100644 --- a/src/uml/qobjects/qumlchangeeventobject_p.h +++ b/src/uml/qobjects/qumlchangeeventobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -181,7 +179,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCHANGEEVENTOBJECT_H diff --git a/src/uml/qobjects/qumlclassifiertemplateparameterobject_p.h b/src/uml/qobjects/qumlclassifiertemplateparameterobject_p.h index cec4291a..a6f12c6a 100644 --- a/src/uml/qobjects/qumlclassifiertemplateparameterobject_p.h +++ b/src/uml/qobjects/qumlclassifiertemplateparameterobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -145,7 +143,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCLASSIFIERTEMPLATEPARAMETEROBJECT_H diff --git a/src/uml/qobjects/qumlclassobject_p.h b/src/uml/qobjects/qumlclassobject_p.h index d048a0b7..f973ec3f 100644 --- a/src/uml/qobjects/qumlclassobject_p.h +++ b/src/uml/qobjects/qumlclassobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -460,7 +458,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCLASSOBJECT_H diff --git a/src/uml/qobjects/qumlclauseobject_p.h b/src/uml/qobjects/qumlclauseobject_p.h index 3637102f..c76db920 100644 --- a/src/uml/qobjects/qumlclauseobject_p.h +++ b/src/uml/qobjects/qumlclauseobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -136,7 +134,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCLAUSEOBJECT_H diff --git a/src/uml/qobjects/qumlclearassociationactionobject_p.h b/src/uml/qobjects/qumlclearassociationactionobject_p.h index 02f233a5..3e070b52 100644 --- a/src/uml/qobjects/qumlclearassociationactionobject_p.h +++ b/src/uml/qobjects/qumlclearassociationactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -279,7 +277,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCLEARASSOCIATIONACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlclearstructuralfeatureactionobject_p.h b/src/uml/qobjects/qumlclearstructuralfeatureactionobject_p.h index 9b6d66b0..3e448aa8 100644 --- a/src/uml/qobjects/qumlclearstructuralfeatureactionobject_p.h +++ b/src/uml/qobjects/qumlclearstructuralfeatureactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -291,7 +289,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCLEARSTRUCTURALFEATUREACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlclearvariableactionobject_p.h b/src/uml/qobjects/qumlclearvariableactionobject_p.h index 63f68052..d960579f 100644 --- a/src/uml/qobjects/qumlclearvariableactionobject_p.h +++ b/src/uml/qobjects/qumlclearvariableactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -275,7 +273,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCLEARVARIABLEACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlcollaborationobject_p.h b/src/uml/qobjects/qumlcollaborationobject_p.h index c7dd368a..27de6914 100644 --- a/src/uml/qobjects/qumlcollaborationobject_p.h +++ b/src/uml/qobjects/qumlcollaborationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -425,7 +423,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCOLLABORATIONOBJECT_H diff --git a/src/uml/qobjects/qumlcollaborationuseobject_p.h b/src/uml/qobjects/qumlcollaborationuseobject_p.h index 0650a51a..60ab957e 100644 --- a/src/uml/qobjects/qumlcollaborationuseobject_p.h +++ b/src/uml/qobjects/qumlcollaborationuseobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -157,7 +155,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCOLLABORATIONUSEOBJECT_H diff --git a/src/uml/qobjects/qumlcombinedfragmentobject_p.h b/src/uml/qobjects/qumlcombinedfragmentobject_p.h index ee8cb100..f89aba57 100644 --- a/src/uml/qobjects/qumlcombinedfragmentobject_p.h +++ b/src/uml/qobjects/qumlcombinedfragmentobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -189,7 +187,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCOMBINEDFRAGMENTOBJECT_H diff --git a/src/uml/qobjects/qumlcommentobject_p.h b/src/uml/qobjects/qumlcommentobject_p.h index 64047f2d..15e4daa0 100644 --- a/src/uml/qobjects/qumlcommentobject_p.h +++ b/src/uml/qobjects/qumlcommentobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -116,7 +114,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCOMMENTOBJECT_H diff --git a/src/uml/qobjects/qumlcommunicationpathobject_p.h b/src/uml/qobjects/qumlcommunicationpathobject_p.h index 84a9e44f..b777b981 100644 --- a/src/uml/qobjects/qumlcommunicationpathobject_p.h +++ b/src/uml/qobjects/qumlcommunicationpathobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -408,7 +406,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCOMMUNICATIONPATHOBJECT_H diff --git a/src/uml/qobjects/qumlcomponentobject_p.h b/src/uml/qobjects/qumlcomponentobject_p.h index 2ac69016..5ff0252b 100644 --- a/src/uml/qobjects/qumlcomponentobject_p.h +++ b/src/uml/qobjects/qumlcomponentobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -497,7 +495,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCOMPONENTOBJECT_H diff --git a/src/uml/qobjects/qumlcomponentrealizationobject_p.h b/src/uml/qobjects/qumlcomponentrealizationobject_p.h index 973f88a2..a4a2a965 100644 --- a/src/uml/qobjects/qumlcomponentrealizationobject_p.h +++ b/src/uml/qobjects/qumlcomponentrealizationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -247,7 +245,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCOMPONENTREALIZATIONOBJECT_H diff --git a/src/uml/qobjects/qumlconditionalnodeobject_p.h b/src/uml/qobjects/qumlconditionalnodeobject_p.h index cd94f5a2..0a8eddcc 100644 --- a/src/uml/qobjects/qumlconditionalnodeobject_p.h +++ b/src/uml/qobjects/qumlconditionalnodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -395,7 +393,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCONDITIONALNODEOBJECT_H diff --git a/src/uml/qobjects/qumlconnectableelementtemplateparameterobject_p.h b/src/uml/qobjects/qumlconnectableelementtemplateparameterobject_p.h index 261de2dd..a906846f 100644 --- a/src/uml/qobjects/qumlconnectableelementtemplateparameterobject_p.h +++ b/src/uml/qobjects/qumlconnectableelementtemplateparameterobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -135,7 +133,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCONNECTABLEELEMENTTEMPLATEPARAMETEROBJECT_H diff --git a/src/uml/qobjects/qumlconnectionpointreferenceobject_p.h b/src/uml/qobjects/qumlconnectionpointreferenceobject_p.h index 56274623..802b6ce7 100644 --- a/src/uml/qobjects/qumlconnectionpointreferenceobject_p.h +++ b/src/uml/qobjects/qumlconnectionpointreferenceobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -187,7 +185,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCONNECTIONPOINTREFERENCEOBJECT_H diff --git a/src/uml/qobjects/qumlconnectorendobject_p.h b/src/uml/qobjects/qumlconnectorendobject_p.h index 152a58a6..9d325f58 100644 --- a/src/uml/qobjects/qumlconnectorendobject_p.h +++ b/src/uml/qobjects/qumlconnectorendobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -164,7 +162,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCONNECTORENDOBJECT_H diff --git a/src/uml/qobjects/qumlconnectorobject_p.h b/src/uml/qobjects/qumlconnectorobject_p.h index 10881580..12d8e83f 100644 --- a/src/uml/qobjects/qumlconnectorobject_p.h +++ b/src/uml/qobjects/qumlconnectorobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -216,7 +214,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCONNECTOROBJECT_H diff --git a/src/uml/qobjects/qumlconsiderignorefragmentobject_p.h b/src/uml/qobjects/qumlconsiderignorefragmentobject_p.h index 71605334..4cc020ea 100644 --- a/src/uml/qobjects/qumlconsiderignorefragmentobject_p.h +++ b/src/uml/qobjects/qumlconsiderignorefragmentobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -202,7 +200,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCONSIDERIGNOREFRAGMENTOBJECT_H diff --git a/src/uml/qobjects/qumlconstraintobject_p.h b/src/uml/qobjects/qumlconstraintobject_p.h index a0399c5e..565d96c1 100644 --- a/src/uml/qobjects/qumlconstraintobject_p.h +++ b/src/uml/qobjects/qumlconstraintobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -190,7 +188,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCONSTRAINTOBJECT_H diff --git a/src/uml/qobjects/qumlcontinuationobject_p.h b/src/uml/qobjects/qumlcontinuationobject_p.h index cc303f24..5401a4d6 100644 --- a/src/uml/qobjects/qumlcontinuationobject_p.h +++ b/src/uml/qobjects/qumlcontinuationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -179,7 +177,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCONTINUATIONOBJECT_H diff --git a/src/uml/qobjects/qumlcontrolflowobject_p.h b/src/uml/qobjects/qumlcontrolflowobject_p.h index a615cd2b..1841da2e 100644 --- a/src/uml/qobjects/qumlcontrolflowobject_p.h +++ b/src/uml/qobjects/qumlcontrolflowobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -218,7 +216,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCONTROLFLOWOBJECT_H diff --git a/src/uml/qobjects/qumlcreatelinkactionobject_p.h b/src/uml/qobjects/qumlcreatelinkactionobject_p.h index 91b7126d..e24ced08 100644 --- a/src/uml/qobjects/qumlcreatelinkactionobject_p.h +++ b/src/uml/qobjects/qumlcreatelinkactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -292,7 +290,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCREATELINKACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlcreatelinkobjectactionobject_p.h b/src/uml/qobjects/qumlcreatelinkobjectactionobject_p.h index 46fd0be9..23f7dba7 100644 --- a/src/uml/qobjects/qumlcreatelinkobjectactionobject_p.h +++ b/src/uml/qobjects/qumlcreatelinkobjectactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -304,7 +302,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCREATELINKOBJECTACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlcreateobjectactionobject_p.h b/src/uml/qobjects/qumlcreateobjectactionobject_p.h index 33cad7f0..14e72291 100644 --- a/src/uml/qobjects/qumlcreateobjectactionobject_p.h +++ b/src/uml/qobjects/qumlcreateobjectactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -279,7 +277,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLCREATEOBJECTACTIONOBJECT_H diff --git a/src/uml/qobjects/qumldatastorenodeobject_p.h b/src/uml/qobjects/qumldatastorenodeobject_p.h index f3faf15b..6393877e 100644 --- a/src/uml/qobjects/qumldatastorenodeobject_p.h +++ b/src/uml/qobjects/qumldatastorenodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -256,7 +254,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDATASTORENODEOBJECT_H diff --git a/src/uml/qobjects/qumldatatypeobject_p.h b/src/uml/qobjects/qumldatatypeobject_p.h index 91655530..50bd05de 100644 --- a/src/uml/qobjects/qumldatatypeobject_p.h +++ b/src/uml/qobjects/qumldatatypeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -382,7 +380,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDATATYPEOBJECT_H diff --git a/src/uml/qobjects/qumldecisionnodeobject_p.h b/src/uml/qobjects/qumldecisionnodeobject_p.h index 6b44e825..59e0f975 100644 --- a/src/uml/qobjects/qumldecisionnodeobject_p.h +++ b/src/uml/qobjects/qumldecisionnodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -229,7 +227,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDECISIONNODEOBJECT_H diff --git a/src/uml/qobjects/qumldependencyobject_p.h b/src/uml/qobjects/qumldependencyobject_p.h index 77a9d4a4..30af306a 100644 --- a/src/uml/qobjects/qumldependencyobject_p.h +++ b/src/uml/qobjects/qumldependencyobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -218,7 +216,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDEPENDENCYOBJECT_H diff --git a/src/uml/qobjects/qumldeploymentobject_p.h b/src/uml/qobjects/qumldeploymentobject_p.h index 495890d1..b353289c 100644 --- a/src/uml/qobjects/qumldeploymentobject_p.h +++ b/src/uml/qobjects/qumldeploymentobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -240,7 +238,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDEPLOYMENTOBJECT_H diff --git a/src/uml/qobjects/qumldeploymentspecificationobject_p.h b/src/uml/qobjects/qumldeploymentspecificationobject_p.h index 6f603c8e..8619ecb7 100644 --- a/src/uml/qobjects/qumldeploymentspecificationobject_p.h +++ b/src/uml/qobjects/qumldeploymentspecificationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -414,7 +412,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDEPLOYMENTSPECIFICATIONOBJECT_H diff --git a/src/uml/qobjects/qumldestroylinkactionobject_p.h b/src/uml/qobjects/qumldestroylinkactionobject_p.h index 7e805d7f..e0a8af36 100644 --- a/src/uml/qobjects/qumldestroylinkactionobject_p.h +++ b/src/uml/qobjects/qumldestroylinkactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -292,7 +290,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDESTROYLINKACTIONOBJECT_H diff --git a/src/uml/qobjects/qumldestroyobjectactionobject_p.h b/src/uml/qobjects/qumldestroyobjectactionobject_p.h index c8157f6c..485ab42a 100644 --- a/src/uml/qobjects/qumldestroyobjectactionobject_p.h +++ b/src/uml/qobjects/qumldestroyobjectactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -285,7 +283,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDESTROYOBJECTACTIONOBJECT_H diff --git a/src/uml/qobjects/qumldestructionoccurrencespecificationobject_p.h b/src/uml/qobjects/qumldestructionoccurrencespecificationobject_p.h index 529f6109..2156f63c 100644 --- a/src/uml/qobjects/qumldestructionoccurrencespecificationobject_p.h +++ b/src/uml/qobjects/qumldestructionoccurrencespecificationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -195,7 +193,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDESTRUCTIONOCCURRENCESPECIFICATIONOBJECT_H diff --git a/src/uml/qobjects/qumldeviceobject_p.h b/src/uml/qobjects/qumldeviceobject_p.h index 94c52b01..42983f62 100644 --- a/src/uml/qobjects/qumldeviceobject_p.h +++ b/src/uml/qobjects/qumldeviceobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -491,7 +489,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDEVICEOBJECT_H diff --git a/src/uml/qobjects/qumldurationconstraintobject_p.h b/src/uml/qobjects/qumldurationconstraintobject_p.h index 7d6eb8d9..5ba6c321 100644 --- a/src/uml/qobjects/qumldurationconstraintobject_p.h +++ b/src/uml/qobjects/qumldurationconstraintobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -210,7 +208,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDURATIONCONSTRAINTOBJECT_H diff --git a/src/uml/qobjects/qumldurationintervalobject_p.h b/src/uml/qobjects/qumldurationintervalobject_p.h index 0e77e4bc..d88f6212 100644 --- a/src/uml/qobjects/qumldurationintervalobject_p.h +++ b/src/uml/qobjects/qumldurationintervalobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -214,7 +212,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDURATIONINTERVALOBJECT_H diff --git a/src/uml/qobjects/qumldurationobject_p.h b/src/uml/qobjects/qumldurationobject_p.h index c87f9421..9a116666 100644 --- a/src/uml/qobjects/qumldurationobject_p.h +++ b/src/uml/qobjects/qumldurationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -207,7 +205,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDURATIONOBJECT_H diff --git a/src/uml/qobjects/qumldurationobservationobject_p.h b/src/uml/qobjects/qumldurationobservationobject_p.h index 10ad0013..21de8d5c 100644 --- a/src/uml/qobjects/qumldurationobservationobject_p.h +++ b/src/uml/qobjects/qumldurationobservationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -185,7 +183,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLDURATIONOBSERVATIONOBJECT_H diff --git a/src/uml/qobjects/qumlelementimportobject_p.h b/src/uml/qobjects/qumlelementimportobject_p.h index 0365280d..66ab434a 100644 --- a/src/uml/qobjects/qumlelementimportobject_p.h +++ b/src/uml/qobjects/qumlelementimportobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -160,7 +158,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLELEMENTIMPORTOBJECT_H diff --git a/src/uml/qobjects/qumlenumerationliteralobject_p.h b/src/uml/qobjects/qumlenumerationliteralobject_p.h index 68441edf..88553016 100644 --- a/src/uml/qobjects/qumlenumerationliteralobject_p.h +++ b/src/uml/qobjects/qumlenumerationliteralobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -220,7 +218,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLENUMERATIONLITERALOBJECT_H diff --git a/src/uml/qobjects/qumlenumerationobject_p.h b/src/uml/qobjects/qumlenumerationobject_p.h index 63fafc5a..5fe63600 100644 --- a/src/uml/qobjects/qumlenumerationobject_p.h +++ b/src/uml/qobjects/qumlenumerationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -395,7 +393,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLENUMERATIONOBJECT_H diff --git a/src/uml/qobjects/qumlexceptionhandlerobject_p.h b/src/uml/qobjects/qumlexceptionhandlerobject_p.h index 28bdcbd8..b3df6dc7 100644 --- a/src/uml/qobjects/qumlexceptionhandlerobject_p.h +++ b/src/uml/qobjects/qumlexceptionhandlerobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -124,7 +122,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLEXCEPTIONHANDLEROBJECT_H diff --git a/src/uml/qobjects/qumlexecutionenvironmentobject_p.h b/src/uml/qobjects/qumlexecutionenvironmentobject_p.h index a4b7dc49..c52f3729 100644 --- a/src/uml/qobjects/qumlexecutionenvironmentobject_p.h +++ b/src/uml/qobjects/qumlexecutionenvironmentobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -491,7 +489,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLEXECUTIONENVIRONMENTOBJECT_H diff --git a/src/uml/qobjects/qumlexecutionoccurrencespecificationobject_p.h b/src/uml/qobjects/qumlexecutionoccurrencespecificationobject_p.h index 7c5b5743..d21bacfe 100644 --- a/src/uml/qobjects/qumlexecutionoccurrencespecificationobject_p.h +++ b/src/uml/qobjects/qumlexecutionoccurrencespecificationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -195,7 +193,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLEXECUTIONOCCURRENCESPECIFICATIONOBJECT_H diff --git a/src/uml/qobjects/qumlexpansionnodeobject_p.h b/src/uml/qobjects/qumlexpansionnodeobject_p.h index 614c133f..7085500e 100644 --- a/src/uml/qobjects/qumlexpansionnodeobject_p.h +++ b/src/uml/qobjects/qumlexpansionnodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -272,7 +270,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLEXPANSIONNODEOBJECT_H diff --git a/src/uml/qobjects/qumlexpansionregionobject_p.h b/src/uml/qobjects/qumlexpansionregionobject_p.h index a022e105..6603a88e 100644 --- a/src/uml/qobjects/qumlexpansionregionobject_p.h +++ b/src/uml/qobjects/qumlexpansionregionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -395,7 +393,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLEXPANSIONREGIONOBJECT_H diff --git a/src/uml/qobjects/qumlexpressionobject_p.h b/src/uml/qobjects/qumlexpressionobject_p.h index 2ca179cd..fe173acb 100644 --- a/src/uml/qobjects/qumlexpressionobject_p.h +++ b/src/uml/qobjects/qumlexpressionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -207,7 +205,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLEXPRESSIONOBJECT_H diff --git a/src/uml/qobjects/qumlextendobject_p.h b/src/uml/qobjects/qumlextendobject_p.h index 10983934..502018d5 100644 --- a/src/uml/qobjects/qumlextendobject_p.h +++ b/src/uml/qobjects/qumlextendobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -196,7 +194,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLEXTENDOBJECT_H diff --git a/src/uml/qobjects/qumlextensionendobject_p.h b/src/uml/qobjects/qumlextensionendobject_p.h index 7c632c84..d1d7fb3c 100644 --- a/src/uml/qobjects/qumlextensionendobject_p.h +++ b/src/uml/qobjects/qumlextensionendobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -405,7 +403,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLEXTENSIONENDOBJECT_H diff --git a/src/uml/qobjects/qumlextensionobject_p.h b/src/uml/qobjects/qumlextensionobject_p.h index 29636a4b..373dc0cd 100644 --- a/src/uml/qobjects/qumlextensionobject_p.h +++ b/src/uml/qobjects/qumlextensionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -427,7 +425,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLEXTENSIONOBJECT_H diff --git a/src/uml/qobjects/qumlextensionpointobject_p.h b/src/uml/qobjects/qumlextensionpointobject_p.h index 8b34de22..481fcd07 100644 --- a/src/uml/qobjects/qumlextensionpointobject_p.h +++ b/src/uml/qobjects/qumlextensionpointobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -179,7 +177,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLEXTENSIONPOINTOBJECT_H diff --git a/src/uml/qobjects/qumlfinalstateobject_p.h b/src/uml/qobjects/qumlfinalstateobject_p.h index 3df009c6..d973fbf2 100644 --- a/src/uml/qobjects/qumlfinalstateobject_p.h +++ b/src/uml/qobjects/qumlfinalstateobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -309,7 +307,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLFINALSTATEOBJECT_H diff --git a/src/uml/qobjects/qumlflowfinalnodeobject_p.h b/src/uml/qobjects/qumlflowfinalnodeobject_p.h index 4b6e617f..fd437d74 100644 --- a/src/uml/qobjects/qumlflowfinalnodeobject_p.h +++ b/src/uml/qobjects/qumlflowfinalnodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -213,7 +211,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLFLOWFINALNODEOBJECT_H diff --git a/src/uml/qobjects/qumlforknodeobject_p.h b/src/uml/qobjects/qumlforknodeobject_p.h index 47a79e6a..efd2b597 100644 --- a/src/uml/qobjects/qumlforknodeobject_p.h +++ b/src/uml/qobjects/qumlforknodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -213,7 +211,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLFORKNODEOBJECT_H diff --git a/src/uml/qobjects/qumlfunctionbehaviorobject_p.h b/src/uml/qobjects/qumlfunctionbehaviorobject_p.h index 1ad5572b..5b5a3183 100644 --- a/src/uml/qobjects/qumlfunctionbehaviorobject_p.h +++ b/src/uml/qobjects/qumlfunctionbehaviorobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -524,7 +522,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLFUNCTIONBEHAVIOROBJECT_H diff --git a/src/uml/qobjects/qumlgateobject_p.h b/src/uml/qobjects/qumlgateobject_p.h index 28ec1064..6e00960a 100644 --- a/src/uml/qobjects/qumlgateobject_p.h +++ b/src/uml/qobjects/qumlgateobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -152,7 +150,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLGATEOBJECT_H diff --git a/src/uml/qobjects/qumlgeneralizationobject_p.h b/src/uml/qobjects/qumlgeneralizationobject_p.h index 3139c22d..3c1b9377 100644 --- a/src/uml/qobjects/qumlgeneralizationobject_p.h +++ b/src/uml/qobjects/qumlgeneralizationobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -156,7 +154,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLGENERALIZATIONOBJECT_H diff --git a/src/uml/qobjects/qumlgeneralizationsetobject_p.h b/src/uml/qobjects/qumlgeneralizationsetobject_p.h index 2fedd8fb..93a96793 100644 --- a/src/uml/qobjects/qumlgeneralizationsetobject_p.h +++ b/src/uml/qobjects/qumlgeneralizationsetobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -196,7 +194,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLGENERALIZATIONSETOBJECT_H diff --git a/src/uml/qobjects/qumlgeneralorderingobject_p.h b/src/uml/qobjects/qumlgeneralorderingobject_p.h index d31f04d9..06db8d67 100644 --- a/src/uml/qobjects/qumlgeneralorderingobject_p.h +++ b/src/uml/qobjects/qumlgeneralorderingobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -156,7 +154,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLGENERALORDERINGOBJECT_H diff --git a/src/uml/qobjects/qumlimageobject_p.h b/src/uml/qobjects/qumlimageobject_p.h index c15a7840..3cbdc124 100644 --- a/src/uml/qobjects/qumlimageobject_p.h +++ b/src/uml/qobjects/qumlimageobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -119,7 +117,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLIMAGEOBJECT_H diff --git a/src/uml/qobjects/qumlincludeobject_p.h b/src/uml/qobjects/qumlincludeobject_p.h index 57b71d55..692dfd4b 100644 --- a/src/uml/qobjects/qumlincludeobject_p.h +++ b/src/uml/qobjects/qumlincludeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -187,7 +185,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINCLUDEOBJECT_H diff --git a/src/uml/qobjects/qumlinformationflowobject_p.h b/src/uml/qobjects/qumlinformationflowobject_p.h index fbdbdb18..6eddc3af 100644 --- a/src/uml/qobjects/qumlinformationflowobject_p.h +++ b/src/uml/qobjects/qumlinformationflowobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -243,7 +241,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINFORMATIONFLOWOBJECT_H diff --git a/src/uml/qobjects/qumlinformationitemobject_p.h b/src/uml/qobjects/qumlinformationitemobject_p.h index 6a6a403e..f198dc7a 100644 --- a/src/uml/qobjects/qumlinformationitemobject_p.h +++ b/src/uml/qobjects/qumlinformationitemobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -375,7 +373,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINFORMATIONITEMOBJECT_H diff --git a/src/uml/qobjects/qumlinitialnodeobject_p.h b/src/uml/qobjects/qumlinitialnodeobject_p.h index cc56af3d..2e172609 100644 --- a/src/uml/qobjects/qumlinitialnodeobject_p.h +++ b/src/uml/qobjects/qumlinitialnodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -213,7 +211,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINITIALNODEOBJECT_H diff --git a/src/uml/qobjects/qumlinputpinobject_p.h b/src/uml/qobjects/qumlinputpinobject_p.h index 75579ba8..bfc6ada2 100644 --- a/src/uml/qobjects/qumlinputpinobject_p.h +++ b/src/uml/qobjects/qumlinputpinobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -314,7 +312,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINPUTPINOBJECT_H diff --git a/src/uml/qobjects/qumlinstancespecificationobject_p.h b/src/uml/qobjects/qumlinstancespecificationobject_p.h index 329e4632..232306b5 100644 --- a/src/uml/qobjects/qumlinstancespecificationobject_p.h +++ b/src/uml/qobjects/qumlinstancespecificationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -209,7 +207,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINSTANCESPECIFICATIONOBJECT_H diff --git a/src/uml/qobjects/qumlinstancevalueobject_p.h b/src/uml/qobjects/qumlinstancevalueobject_p.h index f889b151..7e9bb3bc 100644 --- a/src/uml/qobjects/qumlinstancevalueobject_p.h +++ b/src/uml/qobjects/qumlinstancevalueobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -202,7 +200,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINSTANCEVALUEOBJECT_H diff --git a/src/uml/qobjects/qumlinteractionconstraintobject_p.h b/src/uml/qobjects/qumlinteractionconstraintobject_p.h index 74a00d9b..2153451b 100644 --- a/src/uml/qobjects/qumlinteractionconstraintobject_p.h +++ b/src/uml/qobjects/qumlinteractionconstraintobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -206,7 +204,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINTERACTIONCONSTRAINTOBJECT_H diff --git a/src/uml/qobjects/qumlinteractionobject_p.h b/src/uml/qobjects/qumlinteractionobject_p.h index 129e21e2..80ef77a7 100644 --- a/src/uml/qobjects/qumlinteractionobject_p.h +++ b/src/uml/qobjects/qumlinteractionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -565,7 +563,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINTERACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlinteractionoperandobject_p.h b/src/uml/qobjects/qumlinteractionoperandobject_p.h index b6a1206d..669f1c4d 100644 --- a/src/uml/qobjects/qumlinteractionoperandobject_p.h +++ b/src/uml/qobjects/qumlinteractionoperandobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -227,7 +225,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINTERACTIONOPERANDOBJECT_H diff --git a/src/uml/qobjects/qumlinteractionuseobject_p.h b/src/uml/qobjects/qumlinteractionuseobject_p.h index eaae9a04..2a37fb77 100644 --- a/src/uml/qobjects/qumlinteractionuseobject_p.h +++ b/src/uml/qobjects/qumlinteractionuseobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -196,7 +194,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINTERACTIONUSEOBJECT_H diff --git a/src/uml/qobjects/qumlinterfaceobject_p.h b/src/uml/qobjects/qumlinterfaceobject_p.h index 25ad2791..174a9d91 100644 --- a/src/uml/qobjects/qumlinterfaceobject_p.h +++ b/src/uml/qobjects/qumlinterfaceobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -399,7 +397,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINTERFACEOBJECT_H diff --git a/src/uml/qobjects/qumlinterfacerealizationobject_p.h b/src/uml/qobjects/qumlinterfacerealizationobject_p.h index b9e81700..2d0dd48a 100644 --- a/src/uml/qobjects/qumlinterfacerealizationobject_p.h +++ b/src/uml/qobjects/qumlinterfacerealizationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -246,7 +244,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINTERFACEREALIZATIONOBJECT_H diff --git a/src/uml/qobjects/qumlinterruptibleactivityregionobject_p.h b/src/uml/qobjects/qumlinterruptibleactivityregionobject_p.h index 5b7abb6d..f760b8cc 100644 --- a/src/uml/qobjects/qumlinterruptibleactivityregionobject_p.h +++ b/src/uml/qobjects/qumlinterruptibleactivityregionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -189,7 +187,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINTERRUPTIBLEACTIVITYREGIONOBJECT_H diff --git a/src/uml/qobjects/qumlintervalconstraintobject_p.h b/src/uml/qobjects/qumlintervalconstraintobject_p.h index 9a991a88..6c11c6e5 100644 --- a/src/uml/qobjects/qumlintervalconstraintobject_p.h +++ b/src/uml/qobjects/qumlintervalconstraintobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -198,7 +196,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINTERVALCONSTRAINTOBJECT_H diff --git a/src/uml/qobjects/qumlintervalobject_p.h b/src/uml/qobjects/qumlintervalobject_p.h index d1a20e2d..37cd6aff 100644 --- a/src/uml/qobjects/qumlintervalobject_p.h +++ b/src/uml/qobjects/qumlintervalobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -206,7 +204,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLINTERVALOBJECT_H diff --git a/src/uml/qobjects/qumljoinnodeobject_p.h b/src/uml/qobjects/qumljoinnodeobject_p.h index 8813c423..25b8617f 100644 --- a/src/uml/qobjects/qumljoinnodeobject_p.h +++ b/src/uml/qobjects/qumljoinnodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -230,7 +228,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLJOINNODEOBJECT_H diff --git a/src/uml/qobjects/qumllifelineobject_p.h b/src/uml/qobjects/qumllifelineobject_p.h index 554946a7..2b965db4 100644 --- a/src/uml/qobjects/qumllifelineobject_p.h +++ b/src/uml/qobjects/qumllifelineobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -169,7 +167,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLLIFELINEOBJECT_H diff --git a/src/uml/qobjects/qumllinkendcreationdataobject_p.h b/src/uml/qobjects/qumllinkendcreationdataobject_p.h index b49a0b43..2a8b2ec5 100644 --- a/src/uml/qobjects/qumllinkendcreationdataobject_p.h +++ b/src/uml/qobjects/qumllinkendcreationdataobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -137,7 +135,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLLINKENDCREATIONDATAOBJECT_H diff --git a/src/uml/qobjects/qumllinkenddataobject_p.h b/src/uml/qobjects/qumllinkenddataobject_p.h index 1b1c37c3..9fd14245 100644 --- a/src/uml/qobjects/qumllinkenddataobject_p.h +++ b/src/uml/qobjects/qumllinkenddataobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -120,7 +118,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLLINKENDDATAOBJECT_H diff --git a/src/uml/qobjects/qumllinkenddestructiondataobject_p.h b/src/uml/qobjects/qumllinkenddestructiondataobject_p.h index f7524419..f4c8f15f 100644 --- a/src/uml/qobjects/qumllinkenddestructiondataobject_p.h +++ b/src/uml/qobjects/qumllinkenddestructiondataobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -137,7 +135,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLLINKENDDESTRUCTIONDATAOBJECT_H diff --git a/src/uml/qobjects/qumlliteralbooleanobject_p.h b/src/uml/qobjects/qumlliteralbooleanobject_p.h index 3d74e2f0..d9cd3831 100644 --- a/src/uml/qobjects/qumlliteralbooleanobject_p.h +++ b/src/uml/qobjects/qumlliteralbooleanobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -205,7 +203,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLLITERALBOOLEANOBJECT_H diff --git a/src/uml/qobjects/qumlliteralintegerobject_p.h b/src/uml/qobjects/qumlliteralintegerobject_p.h index e9ef3b06..1df84bb9 100644 --- a/src/uml/qobjects/qumlliteralintegerobject_p.h +++ b/src/uml/qobjects/qumlliteralintegerobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -205,7 +203,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLLITERALINTEGEROBJECT_H diff --git a/src/uml/qobjects/qumlliteralnullobject_p.h b/src/uml/qobjects/qumlliteralnullobject_p.h index c69a2095..b48224d4 100644 --- a/src/uml/qobjects/qumlliteralnullobject_p.h +++ b/src/uml/qobjects/qumlliteralnullobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -192,7 +190,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLLITERALNULLOBJECT_H diff --git a/src/uml/qobjects/qumlliteralrealobject_p.h b/src/uml/qobjects/qumlliteralrealobject_p.h index 51aad617..f6178a81 100644 --- a/src/uml/qobjects/qumlliteralrealobject_p.h +++ b/src/uml/qobjects/qumlliteralrealobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -204,7 +202,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLLITERALREALOBJECT_H diff --git a/src/uml/qobjects/qumlliteralstringobject_p.h b/src/uml/qobjects/qumlliteralstringobject_p.h index 8feb815e..1c607db8 100644 --- a/src/uml/qobjects/qumlliteralstringobject_p.h +++ b/src/uml/qobjects/qumlliteralstringobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -204,7 +202,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLLITERALSTRINGOBJECT_H diff --git a/src/uml/qobjects/qumlliteralunlimitednaturalobject_p.h b/src/uml/qobjects/qumlliteralunlimitednaturalobject_p.h index 3135433d..0dfddcfe 100644 --- a/src/uml/qobjects/qumlliteralunlimitednaturalobject_p.h +++ b/src/uml/qobjects/qumlliteralunlimitednaturalobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -205,7 +203,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLLITERALUNLIMITEDNATURALOBJECT_H diff --git a/src/uml/qobjects/qumlloopnodeobject_p.h b/src/uml/qobjects/qumlloopnodeobject_p.h index ebb304ff..127aaa9f 100644 --- a/src/uml/qobjects/qumlloopnodeobject_p.h +++ b/src/uml/qobjects/qumlloopnodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -414,7 +412,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLLOOPNODEOBJECT_H diff --git a/src/uml/qobjects/qumlmanifestationobject_p.h b/src/uml/qobjects/qumlmanifestationobject_p.h index 8f939e78..6bb8c7d3 100644 --- a/src/uml/qobjects/qumlmanifestationobject_p.h +++ b/src/uml/qobjects/qumlmanifestationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -242,7 +240,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLMANIFESTATIONOBJECT_H diff --git a/src/uml/qobjects/qumlmergenodeobject_p.h b/src/uml/qobjects/qumlmergenodeobject_p.h index 2928dfc7..9eb4341b 100644 --- a/src/uml/qobjects/qumlmergenodeobject_p.h +++ b/src/uml/qobjects/qumlmergenodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -213,7 +211,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLMERGENODEOBJECT_H diff --git a/src/uml/qobjects/qumlmessageobject_p.h b/src/uml/qobjects/qumlmessageobject_p.h index 71b13052..338fd4a1 100644 --- a/src/uml/qobjects/qumlmessageobject_p.h +++ b/src/uml/qobjects/qumlmessageobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -183,7 +181,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLMESSAGEOBJECT_H diff --git a/src/uml/qobjects/qumlmessageoccurrencespecificationobject_p.h b/src/uml/qobjects/qumlmessageoccurrencespecificationobject_p.h index cf895dc0..778fc8d5 100644 --- a/src/uml/qobjects/qumlmessageoccurrencespecificationobject_p.h +++ b/src/uml/qobjects/qumlmessageoccurrencespecificationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -195,7 +193,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLMESSAGEOCCURRENCESPECIFICATIONOBJECT_H diff --git a/src/uml/qobjects/qumlmodelobject_p.h b/src/uml/qobjects/qumlmodelobject_p.h index 3f733d05..192587c5 100644 --- a/src/uml/qobjects/qumlmodelobject_p.h +++ b/src/uml/qobjects/qumlmodelobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -298,7 +296,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLMODELOBJECT_H diff --git a/src/uml/qobjects/qumlnodeobject_p.h b/src/uml/qobjects/qumlnodeobject_p.h index c6c6c75a..024e7ef8 100644 --- a/src/uml/qobjects/qumlnodeobject_p.h +++ b/src/uml/qobjects/qumlnodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -491,7 +489,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLNODEOBJECT_H diff --git a/src/uml/qobjects/qumlobjectflowobject_p.h b/src/uml/qobjects/qumlobjectflowobject_p.h index 4e77aa8e..a8a6dc2c 100644 --- a/src/uml/qobjects/qumlobjectflowobject_p.h +++ b/src/uml/qobjects/qumlobjectflowobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -244,7 +242,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLOBJECTFLOWOBJECT_H diff --git a/src/uml/qobjects/qumloccurrencespecificationobject_p.h b/src/uml/qobjects/qumloccurrencespecificationobject_p.h index ef95b0fa..e1c4f448 100644 --- a/src/uml/qobjects/qumloccurrencespecificationobject_p.h +++ b/src/uml/qobjects/qumloccurrencespecificationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -183,7 +181,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLOCCURRENCESPECIFICATIONOBJECT_H diff --git a/src/uml/qobjects/qumlopaqueactionobject_p.h b/src/uml/qobjects/qumlopaqueactionobject_p.h index 02592ded..1060729c 100644 --- a/src/uml/qobjects/qumlopaqueactionobject_p.h +++ b/src/uml/qobjects/qumlopaqueactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -291,7 +289,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLOPAQUEACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlopaquebehaviorobject_p.h b/src/uml/qobjects/qumlopaquebehaviorobject_p.h index 064eb2dd..668bb1b0 100644 --- a/src/uml/qobjects/qumlopaquebehaviorobject_p.h +++ b/src/uml/qobjects/qumlopaquebehaviorobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -524,7 +522,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLOPAQUEBEHAVIOROBJECT_H diff --git a/src/uml/qobjects/qumlopaqueexpressionobject_p.h b/src/uml/qobjects/qumlopaqueexpressionobject_p.h index 6eef4f5c..ff3c3bfe 100644 --- a/src/uml/qobjects/qumlopaqueexpressionobject_p.h +++ b/src/uml/qobjects/qumlopaqueexpressionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -222,7 +220,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLOPAQUEEXPRESSIONOBJECT_H diff --git a/src/uml/qobjects/qumloperationobject_p.h b/src/uml/qobjects/qumloperationobject_p.h index cbb477d6..6e43f4e6 100644 --- a/src/uml/qobjects/qumloperationobject_p.h +++ b/src/uml/qobjects/qumloperationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -381,7 +379,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLOPERATIONOBJECT_H diff --git a/src/uml/qobjects/qumloperationtemplateparameterobject_p.h b/src/uml/qobjects/qumloperationtemplateparameterobject_p.h index 062903b5..5aae23e6 100644 --- a/src/uml/qobjects/qumloperationtemplateparameterobject_p.h +++ b/src/uml/qobjects/qumloperationtemplateparameterobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -135,7 +133,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLOPERATIONTEMPLATEPARAMETEROBJECT_H diff --git a/src/uml/qobjects/qumloutputpinobject_p.h b/src/uml/qobjects/qumloutputpinobject_p.h index 893c031b..942cb83f 100644 --- a/src/uml/qobjects/qumloutputpinobject_p.h +++ b/src/uml/qobjects/qumloutputpinobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -314,7 +312,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLOUTPUTPINOBJECT_H diff --git a/src/uml/qobjects/qumlpackageimportobject_p.h b/src/uml/qobjects/qumlpackageimportobject_p.h index 2260d3c7..9349f587 100644 --- a/src/uml/qobjects/qumlpackageimportobject_p.h +++ b/src/uml/qobjects/qumlpackageimportobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -153,7 +151,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPACKAGEIMPORTOBJECT_H diff --git a/src/uml/qobjects/qumlpackagemergeobject_p.h b/src/uml/qobjects/qumlpackagemergeobject_p.h index 8eb640f6..08276436 100644 --- a/src/uml/qobjects/qumlpackagemergeobject_p.h +++ b/src/uml/qobjects/qumlpackagemergeobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -146,7 +144,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPACKAGEMERGEOBJECT_H diff --git a/src/uml/qobjects/qumlpackageobject_p.h b/src/uml/qobjects/qumlpackageobject_p.h index 144e8952..5b7a5260 100644 --- a/src/uml/qobjects/qumlpackageobject_p.h +++ b/src/uml/qobjects/qumlpackageobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -286,7 +284,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPACKAGEOBJECT_H diff --git a/src/uml/qobjects/qumlparameterobject_p.h b/src/uml/qobjects/qumlparameterobject_p.h index 82c68d2b..9efa897c 100644 --- a/src/uml/qobjects/qumlparameterobject_p.h +++ b/src/uml/qobjects/qumlparameterobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -274,7 +272,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPARAMETEROBJECT_H diff --git a/src/uml/qobjects/qumlparametersetobject_p.h b/src/uml/qobjects/qumlparametersetobject_p.h index 5f774649..94467a2d 100644 --- a/src/uml/qobjects/qumlparametersetobject_p.h +++ b/src/uml/qobjects/qumlparametersetobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -158,7 +156,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPARAMETERSETOBJECT_H diff --git a/src/uml/qobjects/qumlpartdecompositionobject_p.h b/src/uml/qobjects/qumlpartdecompositionobject_p.h index 1ba7c7e1..002619fa 100644 --- a/src/uml/qobjects/qumlpartdecompositionobject_p.h +++ b/src/uml/qobjects/qumlpartdecompositionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -196,7 +194,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPARTDECOMPOSITIONOBJECT_H diff --git a/src/uml/qobjects/qumlportobject_p.h b/src/uml/qobjects/qumlportobject_p.h index d5238414..375ba9a3 100644 --- a/src/uml/qobjects/qumlportobject_p.h +++ b/src/uml/qobjects/qumlportobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -437,7 +435,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPORTOBJECT_H diff --git a/src/uml/qobjects/qumlprimitivetypeobject_p.h b/src/uml/qobjects/qumlprimitivetypeobject_p.h index 7318a407..ad40999d 100644 --- a/src/uml/qobjects/qumlprimitivetypeobject_p.h +++ b/src/uml/qobjects/qumlprimitivetypeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -382,7 +380,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPRIMITIVETYPEOBJECT_H diff --git a/src/uml/qobjects/qumlprofileapplicationobject_p.h b/src/uml/qobjects/qumlprofileapplicationobject_p.h index 0ccf6633..9102f37c 100644 --- a/src/uml/qobjects/qumlprofileapplicationobject_p.h +++ b/src/uml/qobjects/qumlprofileapplicationobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -151,7 +149,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPROFILEAPPLICATIONOBJECT_H diff --git a/src/uml/qobjects/qumlprofileobject_p.h b/src/uml/qobjects/qumlprofileobject_p.h index f75b3e11..538d7376 100644 --- a/src/uml/qobjects/qumlprofileobject_p.h +++ b/src/uml/qobjects/qumlprofileobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -304,7 +302,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPROFILEOBJECT_H diff --git a/src/uml/qobjects/qumlpropertyobject_p.h b/src/uml/qobjects/qumlpropertyobject_p.h index 6d697465..c379cf51 100644 --- a/src/uml/qobjects/qumlpropertyobject_p.h +++ b/src/uml/qobjects/qumlpropertyobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -395,7 +393,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPROPERTYOBJECT_H diff --git a/src/uml/qobjects/qumlprotocolconformanceobject_p.h b/src/uml/qobjects/qumlprotocolconformanceobject_p.h index 83c4fd39..c6ecdc2f 100644 --- a/src/uml/qobjects/qumlprotocolconformanceobject_p.h +++ b/src/uml/qobjects/qumlprotocolconformanceobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -146,7 +144,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPROTOCOLCONFORMANCEOBJECT_H diff --git a/src/uml/qobjects/qumlprotocolstatemachineobject_p.h b/src/uml/qobjects/qumlprotocolstatemachineobject_p.h index 89808b58..7cccdc49 100644 --- a/src/uml/qobjects/qumlprotocolstatemachineobject_p.h +++ b/src/uml/qobjects/qumlprotocolstatemachineobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -546,7 +544,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPROTOCOLSTATEMACHINEOBJECT_H diff --git a/src/uml/qobjects/qumlprotocoltransitionobject_p.h b/src/uml/qobjects/qumlprotocoltransitionobject_p.h index 3d52d655..7d3b088e 100644 --- a/src/uml/qobjects/qumlprotocoltransitionobject_p.h +++ b/src/uml/qobjects/qumlprotocoltransitionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -276,7 +274,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPROTOCOLTRANSITIONOBJECT_H diff --git a/src/uml/qobjects/qumlpseudostateobject_p.h b/src/uml/qobjects/qumlpseudostateobject_p.h index 76bc00cf..82bc955d 100644 --- a/src/uml/qobjects/qumlpseudostateobject_p.h +++ b/src/uml/qobjects/qumlpseudostateobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -186,7 +184,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLPSEUDOSTATEOBJECT_H diff --git a/src/uml/qobjects/qumlqualifiervalueobject_p.h b/src/uml/qobjects/qumlqualifiervalueobject_p.h index 172bfc09..971fc3a4 100644 --- a/src/uml/qobjects/qumlqualifiervalueobject_p.h +++ b/src/uml/qobjects/qumlqualifiervalueobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -115,7 +113,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLQUALIFIERVALUEOBJECT_H diff --git a/src/uml/qobjects/qumlraiseexceptionactionobject_p.h b/src/uml/qobjects/qumlraiseexceptionactionobject_p.h index afe75013..aee4138d 100644 --- a/src/uml/qobjects/qumlraiseexceptionactionobject_p.h +++ b/src/uml/qobjects/qumlraiseexceptionactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -275,7 +273,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLRAISEEXCEPTIONACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlreadextentactionobject_p.h b/src/uml/qobjects/qumlreadextentactionobject_p.h index 05bc8dfc..5c8c06d2 100644 --- a/src/uml/qobjects/qumlreadextentactionobject_p.h +++ b/src/uml/qobjects/qumlreadextentactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -279,7 +277,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREADEXTENTACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlreadisclassifiedobjectactionobject_p.h b/src/uml/qobjects/qumlreadisclassifiedobjectactionobject_p.h index 55e9ab55..2ed51e1a 100644 --- a/src/uml/qobjects/qumlreadisclassifiedobjectactionobject_p.h +++ b/src/uml/qobjects/qumlreadisclassifiedobjectactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -288,7 +286,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREADISCLASSIFIEDOBJECTACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlreadlinkactionobject_p.h b/src/uml/qobjects/qumlreadlinkactionobject_p.h index 4a85a8db..e03ae1fd 100644 --- a/src/uml/qobjects/qumlreadlinkactionobject_p.h +++ b/src/uml/qobjects/qumlreadlinkactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -296,7 +294,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREADLINKACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlreadlinkobjectendactionobject_p.h b/src/uml/qobjects/qumlreadlinkobjectendactionobject_p.h index df64bf5c..43af855c 100644 --- a/src/uml/qobjects/qumlreadlinkobjectendactionobject_p.h +++ b/src/uml/qobjects/qumlreadlinkobjectendactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -283,7 +281,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREADLINKOBJECTENDACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlreadlinkobjectendqualifieractionobject_p.h b/src/uml/qobjects/qumlreadlinkobjectendqualifieractionobject_p.h index 5f7a8444..973f60c3 100644 --- a/src/uml/qobjects/qumlreadlinkobjectendqualifieractionobject_p.h +++ b/src/uml/qobjects/qumlreadlinkobjectendqualifieractionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -283,7 +281,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREADLINKOBJECTENDQUALIFIERACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlreadselfactionobject_p.h b/src/uml/qobjects/qumlreadselfactionobject_p.h index 2d5bf669..5d1bf2b5 100644 --- a/src/uml/qobjects/qumlreadselfactionobject_p.h +++ b/src/uml/qobjects/qumlreadselfactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -275,7 +273,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREADSELFACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlreadstructuralfeatureactionobject_p.h b/src/uml/qobjects/qumlreadstructuralfeatureactionobject_p.h index c2cf0f5e..8e0241bd 100644 --- a/src/uml/qobjects/qumlreadstructuralfeatureactionobject_p.h +++ b/src/uml/qobjects/qumlreadstructuralfeatureactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -291,7 +289,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREADSTRUCTURALFEATUREACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlreadvariableactionobject_p.h b/src/uml/qobjects/qumlreadvariableactionobject_p.h index 9a5cf31b..b5cff5ae 100644 --- a/src/uml/qobjects/qumlreadvariableactionobject_p.h +++ b/src/uml/qobjects/qumlreadvariableactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -287,7 +285,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREADVARIABLEACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlrealizationobject_p.h b/src/uml/qobjects/qumlrealizationobject_p.h index 4bcbbd49..d6fc2c76 100644 --- a/src/uml/qobjects/qumlrealizationobject_p.h +++ b/src/uml/qobjects/qumlrealizationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -230,7 +228,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREALIZATIONOBJECT_H diff --git a/src/uml/qobjects/qumlreceptionobject_p.h b/src/uml/qobjects/qumlreceptionobject_p.h index d0ce8518..f1d9503f 100644 --- a/src/uml/qobjects/qumlreceptionobject_p.h +++ b/src/uml/qobjects/qumlreceptionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -281,7 +279,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLRECEPTIONOBJECT_H diff --git a/src/uml/qobjects/qumlreclassifyobjectactionobject_p.h b/src/uml/qobjects/qumlreclassifyobjectactionobject_p.h index 6b704e2a..7ffa133f 100644 --- a/src/uml/qobjects/qumlreclassifyobjectactionobject_p.h +++ b/src/uml/qobjects/qumlreclassifyobjectactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -290,7 +288,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLRECLASSIFYOBJECTACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlredefinabletemplatesignatureobject_p.h b/src/uml/qobjects/qumlredefinabletemplatesignatureobject_p.h index b6bf3ad1..9eb7aa20 100644 --- a/src/uml/qobjects/qumlredefinabletemplatesignatureobject_p.h +++ b/src/uml/qobjects/qumlredefinabletemplatesignatureobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -213,7 +211,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREDEFINABLETEMPLATESIGNATUREOBJECT_H diff --git a/src/uml/qobjects/qumlreduceactionobject_p.h b/src/uml/qobjects/qumlreduceactionobject_p.h index 67c2779f..294cfb4c 100644 --- a/src/uml/qobjects/qumlreduceactionobject_p.h +++ b/src/uml/qobjects/qumlreduceactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -288,7 +286,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREDUCEACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlregionobject_p.h b/src/uml/qobjects/qumlregionobject_p.h index db973683..9e99ce38 100644 --- a/src/uml/qobjects/qumlregionobject_p.h +++ b/src/uml/qobjects/qumlregionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -244,7 +242,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREGIONOBJECT_H diff --git a/src/uml/qobjects/qumlremovestructuralfeaturevalueactionobject_p.h b/src/uml/qobjects/qumlremovestructuralfeaturevalueactionobject_p.h index f1a46074..f247a2ae 100644 --- a/src/uml/qobjects/qumlremovestructuralfeaturevalueactionobject_p.h +++ b/src/uml/qobjects/qumlremovestructuralfeaturevalueactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -312,7 +310,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREMOVESTRUCTURALFEATUREVALUEACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlremovevariablevalueactionobject_p.h b/src/uml/qobjects/qumlremovevariablevalueactionobject_p.h index 36f685e3..7ce198a7 100644 --- a/src/uml/qobjects/qumlremovevariablevalueactionobject_p.h +++ b/src/uml/qobjects/qumlremovevariablevalueactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -304,7 +302,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREMOVEVARIABLEVALUEACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlreplyactionobject_p.h b/src/uml/qobjects/qumlreplyactionobject_p.h index 879fbcd5..e179d398 100644 --- a/src/uml/qobjects/qumlreplyactionobject_p.h +++ b/src/uml/qobjects/qumlreplyactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -284,7 +282,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLREPLYACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlsendobjectactionobject_p.h b/src/uml/qobjects/qumlsendobjectactionobject_p.h index 92824f6c..cb8aea74 100644 --- a/src/uml/qobjects/qumlsendobjectactionobject_p.h +++ b/src/uml/qobjects/qumlsendobjectactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -291,7 +289,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSENDOBJECTACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlsendsignalactionobject_p.h b/src/uml/qobjects/qumlsendsignalactionobject_p.h index 32bef81a..afe4a1ae 100644 --- a/src/uml/qobjects/qumlsendsignalactionobject_p.h +++ b/src/uml/qobjects/qumlsendsignalactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -296,7 +294,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSENDSIGNALACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlsequencenodeobject_p.h b/src/uml/qobjects/qumlsequencenodeobject_p.h index adb0402b..019ac190 100644 --- a/src/uml/qobjects/qumlsequencenodeobject_p.h +++ b/src/uml/qobjects/qumlsequencenodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -380,7 +378,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSEQUENCENODEOBJECT_H diff --git a/src/uml/qobjects/qumlsignaleventobject_p.h b/src/uml/qobjects/qumlsignaleventobject_p.h index 92cfe6df..2898036f 100644 --- a/src/uml/qobjects/qumlsignaleventobject_p.h +++ b/src/uml/qobjects/qumlsignaleventobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -181,7 +179,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSIGNALEVENTOBJECT_H diff --git a/src/uml/qobjects/qumlsignalobject_p.h b/src/uml/qobjects/qumlsignalobject_p.h index 89d6706b..07e0a3a4 100644 --- a/src/uml/qobjects/qumlsignalobject_p.h +++ b/src/uml/qobjects/qumlsignalobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -375,7 +373,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSIGNALOBJECT_H diff --git a/src/uml/qobjects/qumlslotobject_p.h b/src/uml/qobjects/qumlslotobject_p.h index 3ac84197..612512cb 100644 --- a/src/uml/qobjects/qumlslotobject_p.h +++ b/src/uml/qobjects/qumlslotobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -120,7 +118,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSLOTOBJECT_H diff --git a/src/uml/qobjects/qumlstartclassifierbehavioractionobject_p.h b/src/uml/qobjects/qumlstartclassifierbehavioractionobject_p.h index 6d0f6a1e..c8577f40 100644 --- a/src/uml/qobjects/qumlstartclassifierbehavioractionobject_p.h +++ b/src/uml/qobjects/qumlstartclassifierbehavioractionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -275,7 +273,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSTARTCLASSIFIERBEHAVIORACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlstartobjectbehavioractionobject_p.h b/src/uml/qobjects/qumlstartobjectbehavioractionobject_p.h index 98317430..a810e213 100644 --- a/src/uml/qobjects/qumlstartobjectbehavioractionobject_p.h +++ b/src/uml/qobjects/qumlstartobjectbehavioractionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -310,7 +308,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSTARTOBJECTBEHAVIORACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlstateinvariantobject_p.h b/src/uml/qobjects/qumlstateinvariantobject_p.h index 50b841b0..40e64469 100644 --- a/src/uml/qobjects/qumlstateinvariantobject_p.h +++ b/src/uml/qobjects/qumlstateinvariantobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -177,7 +175,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSTATEINVARIANTOBJECT_H diff --git a/src/uml/qobjects/qumlstatemachineobject_p.h b/src/uml/qobjects/qumlstatemachineobject_p.h index aae8ca7f..814b2710 100644 --- a/src/uml/qobjects/qumlstatemachineobject_p.h +++ b/src/uml/qobjects/qumlstatemachineobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -533,7 +531,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSTATEMACHINEOBJECT_H diff --git a/src/uml/qobjects/qumlstateobject_p.h b/src/uml/qobjects/qumlstateobject_p.h index bdc0e470..5d113bc0 100644 --- a/src/uml/qobjects/qumlstateobject_p.h +++ b/src/uml/qobjects/qumlstateobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -309,7 +307,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSTATEOBJECT_H diff --git a/src/uml/qobjects/qumlstereotypeobject_p.h b/src/uml/qobjects/qumlstereotypeobject_p.h index 518a2fcb..c3f690b7 100644 --- a/src/uml/qobjects/qumlstereotypeobject_p.h +++ b/src/uml/qobjects/qumlstereotypeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -480,7 +478,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSTEREOTYPEOBJECT_H diff --git a/src/uml/qobjects/qumlstringexpressionobject_p.h b/src/uml/qobjects/qumlstringexpressionobject_p.h index 4171fa6d..b559c0f3 100644 --- a/src/uml/qobjects/qumlstringexpressionobject_p.h +++ b/src/uml/qobjects/qumlstringexpressionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -247,7 +245,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSTRINGEXPRESSIONOBJECT_H diff --git a/src/uml/qobjects/qumlstructuredactivitynodeobject_p.h b/src/uml/qobjects/qumlstructuredactivitynodeobject_p.h index 24856995..7fd48d4e 100644 --- a/src/uml/qobjects/qumlstructuredactivitynodeobject_p.h +++ b/src/uml/qobjects/qumlstructuredactivitynodeobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -372,7 +370,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSTRUCTUREDACTIVITYNODEOBJECT_H diff --git a/src/uml/qobjects/qumlsubstitutionobject_p.h b/src/uml/qobjects/qumlsubstitutionobject_p.h index dc3cb6b5..9af2e61b 100644 --- a/src/uml/qobjects/qumlsubstitutionobject_p.h +++ b/src/uml/qobjects/qumlsubstitutionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -246,7 +244,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLSUBSTITUTIONOBJECT_H diff --git a/src/uml/qobjects/qumltemplatebindingobject_p.h b/src/uml/qobjects/qumltemplatebindingobject_p.h index 7e063e9b..d4cd3283 100644 --- a/src/uml/qobjects/qumltemplatebindingobject_p.h +++ b/src/uml/qobjects/qumltemplatebindingobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -151,7 +149,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTEMPLATEBINDINGOBJECT_H diff --git a/src/uml/qobjects/qumltemplateparameterobject_p.h b/src/uml/qobjects/qumltemplateparameterobject_p.h index 2542d99e..9b672ae1 100644 --- a/src/uml/qobjects/qumltemplateparameterobject_p.h +++ b/src/uml/qobjects/qumltemplateparameterobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -127,7 +125,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTEMPLATEPARAMETEROBJECT_H diff --git a/src/uml/qobjects/qumltemplateparametersubstitutionobject_p.h b/src/uml/qobjects/qumltemplateparametersubstitutionobject_p.h index a5810ad9..9e9b0379 100644 --- a/src/uml/qobjects/qumltemplateparametersubstitutionobject_p.h +++ b/src/uml/qobjects/qumltemplateparametersubstitutionobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -123,7 +121,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTEMPLATEPARAMETERSUBSTITUTIONOBJECT_H diff --git a/src/uml/qobjects/qumltemplatesignatureobject_p.h b/src/uml/qobjects/qumltemplatesignatureobject_p.h index fe52a825..b6eca62e 100644 --- a/src/uml/qobjects/qumltemplatesignatureobject_p.h +++ b/src/uml/qobjects/qumltemplatesignatureobject_p.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -121,7 +119,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTEMPLATESIGNATUREOBJECT_H diff --git a/src/uml/qobjects/qumltestidentityactionobject_p.h b/src/uml/qobjects/qumltestidentityactionobject_p.h index 9d1e8c32..e01169ba 100644 --- a/src/uml/qobjects/qumltestidentityactionobject_p.h +++ b/src/uml/qobjects/qumltestidentityactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -283,7 +281,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTESTIDENTITYACTIONOBJECT_H diff --git a/src/uml/qobjects/qumltimeconstraintobject_p.h b/src/uml/qobjects/qumltimeconstraintobject_p.h index 9d6bd329..f734434f 100644 --- a/src/uml/qobjects/qumltimeconstraintobject_p.h +++ b/src/uml/qobjects/qumltimeconstraintobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -211,7 +209,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTIMECONSTRAINTOBJECT_H diff --git a/src/uml/qobjects/qumltimeeventobject_p.h b/src/uml/qobjects/qumltimeeventobject_p.h index 77b6dced..230473cd 100644 --- a/src/uml/qobjects/qumltimeeventobject_p.h +++ b/src/uml/qobjects/qumltimeeventobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -186,7 +184,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTIMEEVENTOBJECT_H diff --git a/src/uml/qobjects/qumltimeexpressionobject_p.h b/src/uml/qobjects/qumltimeexpressionobject_p.h index b9e08b8c..198115ca 100644 --- a/src/uml/qobjects/qumltimeexpressionobject_p.h +++ b/src/uml/qobjects/qumltimeexpressionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -207,7 +205,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTIMEEXPRESSIONOBJECT_H diff --git a/src/uml/qobjects/qumltimeintervalobject_p.h b/src/uml/qobjects/qumltimeintervalobject_p.h index e2bf3d3f..1ecbc461 100644 --- a/src/uml/qobjects/qumltimeintervalobject_p.h +++ b/src/uml/qobjects/qumltimeintervalobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -214,7 +212,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTIMEINTERVALOBJECT_H diff --git a/src/uml/qobjects/qumltimeobservationobject_p.h b/src/uml/qobjects/qumltimeobservationobject_p.h index 1481a5af..6e639ee5 100644 --- a/src/uml/qobjects/qumltimeobservationobject_p.h +++ b/src/uml/qobjects/qumltimeobservationobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -186,7 +184,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTIMEOBSERVATIONOBJECT_H diff --git a/src/uml/qobjects/qumltransitionobject_p.h b/src/uml/qobjects/qumltransitionobject_p.h index ec8f622f..c5c30cfd 100644 --- a/src/uml/qobjects/qumltransitionobject_p.h +++ b/src/uml/qobjects/qumltransitionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -255,7 +253,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTRANSITIONOBJECT_H diff --git a/src/uml/qobjects/qumltriggerobject_p.h b/src/uml/qobjects/qumltriggerobject_p.h index bfcc867b..d57478ff 100644 --- a/src/uml/qobjects/qumltriggerobject_p.h +++ b/src/uml/qobjects/qumltriggerobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -157,7 +155,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLTRIGGEROBJECT_H diff --git a/src/uml/qobjects/qumlunmarshallactionobject_p.h b/src/uml/qobjects/qumlunmarshallactionobject_p.h index ba6e61c6..cc00c7c1 100644 --- a/src/uml/qobjects/qumlunmarshallactionobject_p.h +++ b/src/uml/qobjects/qumlunmarshallactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -284,7 +282,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLUNMARSHALLACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlusageobject_p.h b/src/uml/qobjects/qumlusageobject_p.h index 6c14cb4e..e6678e6a 100644 --- a/src/uml/qobjects/qumlusageobject_p.h +++ b/src/uml/qobjects/qumlusageobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -218,7 +216,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLUSAGEOBJECT_H diff --git a/src/uml/qobjects/qumlusecaseobject_p.h b/src/uml/qobjects/qumlusecaseobject_p.h index 519f2543..3d22e9d9 100644 --- a/src/uml/qobjects/qumlusecaseobject_p.h +++ b/src/uml/qobjects/qumlusecaseobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -415,7 +413,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLUSECASEOBJECT_H diff --git a/src/uml/qobjects/qumlvaluepinobject_p.h b/src/uml/qobjects/qumlvaluepinobject_p.h index 55df49fa..4f647dfc 100644 --- a/src/uml/qobjects/qumlvaluepinobject_p.h +++ b/src/uml/qobjects/qumlvaluepinobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -326,7 +324,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLVALUEPINOBJECT_H diff --git a/src/uml/qobjects/qumlvaluespecificationactionobject_p.h b/src/uml/qobjects/qumlvaluespecificationactionobject_p.h index 5b2e18f6..30ca6278 100644 --- a/src/uml/qobjects/qumlvaluespecificationactionobject_p.h +++ b/src/uml/qobjects/qumlvaluespecificationactionobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -279,7 +277,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLVALUESPECIFICATIONACTIONOBJECT_H diff --git a/src/uml/qobjects/qumlvariableobject_p.h b/src/uml/qobjects/qumlvariableobject_p.h index b3c05891..60b228a8 100644 --- a/src/uml/qobjects/qumlvariableobject_p.h +++ b/src/uml/qobjects/qumlvariableobject_p.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -249,7 +247,5 @@ protected: QT_END_NAMESPACE -QT_END_HEADER - #endif // QUMLVARIABLEOBJECT_H diff --git a/src/uml/qtumlnamespace.h b/src/uml/qtumlnamespace.h index 89d7156b..94338202 100644 --- a/src/uml/qtumlnamespace.h +++ b/src/uml/qtumlnamespace.h @@ -45,8 +45,6 @@ #include <QtCore/QObject> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -186,7 +184,5 @@ public: QT_END_NAMESPACE -QT_END_HEADER - #endif // QTUMLNAMESPACE_H diff --git a/src/uml/qumlabstraction.cpp b/src/uml/qumlabstraction.cpp index c7160fe9..18c5297f 100644 --- a/src/uml/qumlabstraction.cpp +++ b/src/uml/qumlabstraction.cpp @@ -61,6 +61,10 @@ QT_BEGIN_NAMESPACE \brief An abstraction is a relationship that relates two elements or sets of elements that represent the same concept at different levels of abstraction or from different viewpoints. */ + +/*! + Creates a new QUmlAbstraction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlAbstraction::QUmlAbstraction(bool createQModelingObject) : QUmlDependency(false), _mapping(0) @@ -69,6 +73,9 @@ QUmlAbstraction::QUmlAbstraction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlAbstractionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlAbstraction. +*/ QModelingElement *QUmlAbstraction::clone() const { QUmlAbstraction *c = new QUmlAbstraction; @@ -97,6 +104,8 @@ QModelingElement *QUmlAbstraction::clone() const /*! An composition of an Expression that states the abstraction relationship between the supplier and the client. In some cases, such as Derivation, it is usually formal and unidirectional; in other cases, such as Trace, it is usually informal and bidirectional. The mapping expression is optional and may be omitted if the precise relationship between the elements is not specified. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlOpaqueExpression *QUmlAbstraction::mapping() const { @@ -105,6 +114,9 @@ QUmlOpaqueExpression *QUmlAbstraction::mapping() const return _mapping; } +/*! + Adjusts mapping to \a mapping. + */ void QUmlAbstraction::setMapping(QUmlOpaqueExpression *mapping) { // This is a read-write association end diff --git a/src/uml/qumlabstraction.h b/src/uml/qumlabstraction.h index 3bffc485..8911c817 100644 --- a/src/uml/qumlabstraction.h +++ b/src/uml/qumlabstraction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlDependency> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlAbstraction) *) -QT_END_HEADER - #endif // QUMLABSTRACTION_H diff --git a/src/uml/qumlacceptcallaction.cpp b/src/uml/qumlacceptcallaction.cpp index 4e1e771f..e4632757 100644 --- a/src/uml/qumlacceptcallaction.cpp +++ b/src/uml/qumlacceptcallaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief An accept call action is an accept event action representing the receipt of a synchronous call request. In addition to the normal operation parameters, the action produces an output that is needed later to supply the information to the reply action necessary to return control to the caller. This action is for synchronous calls. If it is used to handle an asynchronous call, execution of the subsequent reply action will complete immediately with no effects. */ + +/*! + Creates a new QUmlAcceptCallAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlAcceptCallAction::QUmlAcceptCallAction(bool createQModelingObject) : QUmlAcceptEventAction(false), _returnInformation(0) @@ -81,6 +85,9 @@ QUmlAcceptCallAction::QUmlAcceptCallAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlAcceptCallActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlAcceptCallAction. +*/ QModelingElement *QUmlAcceptCallAction::clone() const { QUmlAcceptCallAction *c = new QUmlAcceptCallAction; @@ -128,6 +135,8 @@ QModelingElement *QUmlAcceptCallAction::clone() const /*! Pin where a value is placed containing sufficient information to perform a subsequent reply and return control to the caller. The contents of this value are opaque. It can be passed and copied but it cannot be manipulated by the model. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlAcceptCallAction::returnInformation() const { @@ -136,6 +145,9 @@ QUmlOutputPin *QUmlAcceptCallAction::returnInformation() const return _returnInformation; } +/*! + Adjusts returnInformation to \a returnInformation. + */ void QUmlAcceptCallAction::setReturnInformation(QUmlOutputPin *returnInformation) { // This is a read-write association end diff --git a/src/uml/qumlacceptcallaction.h b/src/uml/qumlacceptcallaction.h index cc9c118a..27013a7b 100644 --- a/src/uml/qumlacceptcallaction.h +++ b/src/uml/qumlacceptcallaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAcceptEventAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlAcceptCallAction) *) -QT_END_HEADER - #endif // QUMLACCEPTCALLACTION_H diff --git a/src/uml/qumlaccepteventaction.cpp b/src/uml/qumlaccepteventaction.cpp index fc40adbe..038ec19e 100644 --- a/src/uml/qumlaccepteventaction.cpp +++ b/src/uml/qumlaccepteventaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A accept event action is an action that waits for the occurrence of an event meeting specified conditions. */ + +/*! + Creates a new QUmlAcceptEventAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlAcceptEventAction::QUmlAcceptEventAction(bool createQModelingObject) : _isUnmarshall(false) { @@ -80,6 +84,9 @@ QUmlAcceptEventAction::QUmlAcceptEventAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlAcceptEventActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlAcceptEventAction. +*/ QModelingElement *QUmlAcceptEventAction::clone() const { QUmlAcceptEventAction *c = new QUmlAcceptEventAction; @@ -133,6 +140,9 @@ bool QUmlAcceptEventAction::isUnmarshall() const return _isUnmarshall; } +/*! + Adjusts isUnmarshall to \a isUnmarshall. + */ void QUmlAcceptEventAction::setUnmarshall(bool isUnmarshall) { // This is a read-write property @@ -145,6 +155,10 @@ void QUmlAcceptEventAction::setUnmarshall(bool isUnmarshall) /*! Pins holding the received event objects or their attributes. Event objects may be copied in transmission, so identity might not be preserved. + + \sa addResult(), removeResult() + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ const QSet<QUmlOutputPin *> QUmlAcceptEventAction::results() const { @@ -153,6 +167,11 @@ const QSet<QUmlOutputPin *> QUmlAcceptEventAction::results() const return _results; } +/*! + Adds \a result to results. + + \sa results(), removeResult() + */ void QUmlAcceptEventAction::addResult(QUmlOutputPin *result) { // This is a read-write association end @@ -168,6 +187,11 @@ void QUmlAcceptEventAction::addResult(QUmlOutputPin *result) } } +/*! + Removes \a result from results. + + \sa results(), addResult() + */ void QUmlAcceptEventAction::removeResult(QUmlOutputPin *result) { // This is a read-write association end @@ -184,6 +208,10 @@ void QUmlAcceptEventAction::removeResult(QUmlOutputPin *result) /*! The type of events accepted by the action, as specified by triggers. For triggers with signal events, a signal of the specified type or any subtype of the specified signal type is accepted. + + \sa addTrigger(), removeTrigger() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlTrigger *> QUmlAcceptEventAction::triggers() const { @@ -192,6 +220,11 @@ const QSet<QUmlTrigger *> QUmlAcceptEventAction::triggers() const return _triggers; } +/*! + Adds \a trigger to triggers. + + \sa triggers(), removeTrigger() + */ void QUmlAcceptEventAction::addTrigger(QUmlTrigger *trigger) { // This is a read-write association end @@ -207,6 +240,11 @@ void QUmlAcceptEventAction::addTrigger(QUmlTrigger *trigger) } } +/*! + Removes \a trigger from triggers. + + \sa triggers(), addTrigger() + */ void QUmlAcceptEventAction::removeTrigger(QUmlTrigger *trigger) { // This is a read-write association end diff --git a/src/uml/qumlaccepteventaction.h b/src/uml/qumlaccepteventaction.h index 8ee2f0e5..3ef589ff 100644 --- a/src/uml/qumlaccepteventaction.h +++ b/src/uml/qumlaccepteventaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlAcceptEventAction) *) -QT_END_HEADER - #endif // QUMLACCEPTEVENTACTION_H diff --git a/src/uml/qumlaction.cpp b/src/uml/qumlaction.cpp index 459ade5e..a7c725d1 100644 --- a/src/uml/qumlaction.cpp +++ b/src/uml/qumlaction.cpp @@ -69,12 +69,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief An action has pre- and post-conditions.An action represents a single step within an activity, that is, one that is not further decomposed within the activity.An action is a named element that is the fundamental unit of executable functionality. The execution of an action represents some transformation or processing in the modeled system, be it a computer system or otherwise. + + \b {QUmlAction is an abstract class.} */ + +/*! + Creates a new QUmlAction. +*/ QUmlAction::QUmlAction() : _isLocallyReentrant(false) { } +/*! + Returns a deep-copied clone of the QUmlAction. +*/ QModelingElement *QUmlAction::clone() const { QUmlAction *c = new QUmlAction; @@ -115,6 +124,8 @@ QModelingElement *QUmlAction::clone() const /*! The classifier that owns the behavior of which this action is a part. + + \b {This is a read-only derived property.} */ QUmlClassifier *QUmlAction::context() const { @@ -125,6 +136,9 @@ QUmlClassifier *QUmlAction::context() const return 0; } +/*! + Adjusts context to \a context. + */ void QUmlAction::setContext(QUmlClassifier *context) { // This is a read-only derived association end @@ -139,6 +153,10 @@ void QUmlAction::setContext(QUmlClassifier *context) /*! The ordered set of input pins connected to the Action. These are among the total set of inputs. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QList<QUmlInputPin *> QUmlAction::inputs() const { @@ -147,6 +165,11 @@ const QList<QUmlInputPin *> QUmlAction::inputs() const return _inputs; } +/*! + Adds \a input to inputs. + + \sa inputs(), removeInput() + */ void QUmlAction::addInput(QUmlInputPin *input) { // This is a read-only derived union association end @@ -162,6 +185,11 @@ void QUmlAction::addInput(QUmlInputPin *input) } } +/*! + Removes \a input from inputs. + + \sa inputs(), addInput() + */ void QUmlAction::removeInput(QUmlInputPin *input) { // This is a read-only derived union association end @@ -186,6 +214,9 @@ bool QUmlAction::isLocallyReentrant() const return _isLocallyReentrant; } +/*! + Adjusts isLocallyReentrant to \a isLocallyReentrant. + */ void QUmlAction::setLocallyReentrant(bool isLocallyReentrant) { // This is a read-write property @@ -198,6 +229,10 @@ void QUmlAction::setLocallyReentrant(bool isLocallyReentrant) /*! Constraint that must be satisfied when executed is completed. + + \sa addLocalPostcondition(), removeLocalPostcondition() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlConstraint *> QUmlAction::localPostconditions() const { @@ -206,6 +241,11 @@ const QSet<QUmlConstraint *> QUmlAction::localPostconditions() const return _localPostconditions; } +/*! + Adds \a localPostcondition to localPostconditions. + + \sa localPostconditions(), removeLocalPostcondition() + */ void QUmlAction::addLocalPostcondition(QUmlConstraint *localPostcondition) { // This is a read-write association end @@ -221,6 +261,11 @@ void QUmlAction::addLocalPostcondition(QUmlConstraint *localPostcondition) } } +/*! + Removes \a localPostcondition from localPostconditions. + + \sa localPostconditions(), addLocalPostcondition() + */ void QUmlAction::removeLocalPostcondition(QUmlConstraint *localPostcondition) { // This is a read-write association end @@ -237,6 +282,10 @@ void QUmlAction::removeLocalPostcondition(QUmlConstraint *localPostcondition) /*! Constraint that must be satisfied when execution is started. + + \sa addLocalPrecondition(), removeLocalPrecondition() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlConstraint *> QUmlAction::localPreconditions() const { @@ -245,6 +294,11 @@ const QSet<QUmlConstraint *> QUmlAction::localPreconditions() const return _localPreconditions; } +/*! + Adds \a localPrecondition to localPreconditions. + + \sa localPreconditions(), removeLocalPrecondition() + */ void QUmlAction::addLocalPrecondition(QUmlConstraint *localPrecondition) { // This is a read-write association end @@ -260,6 +314,11 @@ void QUmlAction::addLocalPrecondition(QUmlConstraint *localPrecondition) } } +/*! + Removes \a localPrecondition from localPreconditions. + + \sa localPreconditions(), addLocalPrecondition() + */ void QUmlAction::removeLocalPrecondition(QUmlConstraint *localPrecondition) { // This is a read-write association end @@ -276,6 +335,10 @@ void QUmlAction::removeLocalPrecondition(QUmlConstraint *localPrecondition) /*! The ordered set of output pins connected to the Action. The action places its results onto pins in this set. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QList<QUmlOutputPin *> QUmlAction::outputs() const { @@ -284,6 +347,11 @@ const QList<QUmlOutputPin *> QUmlAction::outputs() const return _outputs; } +/*! + Adds \a output to outputs. + + \sa outputs(), removeOutput() + */ void QUmlAction::addOutput(QUmlOutputPin *output) { // This is a read-only derived union association end @@ -299,6 +367,11 @@ void QUmlAction::addOutput(QUmlOutputPin *output) } } +/*! + Removes \a output from outputs. + + \sa outputs(), addOutput() + */ void QUmlAction::removeOutput(QUmlOutputPin *output) { // This is a read-only derived union association end diff --git a/src/uml/qumlaction.h b/src/uml/qumlaction.h index d9f27ecb..93b6375b 100644 --- a/src/uml/qumlaction.h +++ b/src/uml/qumlaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlExecutableNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -93,7 +91,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlAction) *) -QT_END_HEADER - #endif // QUMLACTION_H diff --git a/src/uml/qumlactionexecutionspecification.cpp b/src/uml/qumlactionexecutionspecification.cpp index 89b7301e..83245057 100644 --- a/src/uml/qumlactionexecutionspecification.cpp +++ b/src/uml/qumlactionexecutionspecification.cpp @@ -65,6 +65,10 @@ QT_BEGIN_NAMESPACE \brief An action execution specification is a kind of execution specification representing the execution of an action. */ + +/*! + Creates a new QUmlActionExecutionSpecification. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlActionExecutionSpecification::QUmlActionExecutionSpecification(bool createQModelingObject) : _action(0) { @@ -72,6 +76,9 @@ QUmlActionExecutionSpecification::QUmlActionExecutionSpecification(bool createQM _qModelingObject = qobject_cast<QModelingObject *>(new QUmlActionExecutionSpecificationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlActionExecutionSpecification. +*/ QModelingElement *QUmlActionExecutionSpecification::clone() const { QUmlActionExecutionSpecification *c = new QUmlActionExecutionSpecification; @@ -112,6 +119,9 @@ QUmlAction *QUmlActionExecutionSpecification::action() const return _action; } +/*! + Adjusts action to \a action. + */ void QUmlActionExecutionSpecification::setAction(QUmlAction *action) { // This is a read-write association end diff --git a/src/uml/qumlactionexecutionspecification.h b/src/uml/qumlactionexecutionspecification.h index d79771c2..60d344a6 100644 --- a/src/uml/qumlactionexecutionspecification.h +++ b/src/uml/qumlactionexecutionspecification.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlExecutionSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlActionExecutionSpecification) *) -QT_END_HEADER - #endif // QUMLACTIONEXECUTIONSPECIFICATION_H diff --git a/src/uml/qumlactioninputpin.cpp b/src/uml/qumlactioninputpin.cpp index 0fa0e504..da1d0f51 100644 --- a/src/uml/qumlactioninputpin.cpp +++ b/src/uml/qumlactioninputpin.cpp @@ -74,6 +74,10 @@ QT_BEGIN_NAMESPACE \brief An action input pin is a kind of pin that executes an action to determine the values to input to another. */ + +/*! + Creates a new QUmlActionInputPin. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlActionInputPin::QUmlActionInputPin(bool createQModelingObject) : QUmlInputPin(false), _fromAction(0) @@ -82,6 +86,9 @@ QUmlActionInputPin::QUmlActionInputPin(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlActionInputPinObject(this)); } +/*! + Returns a deep-copied clone of the QUmlActionInputPin. +*/ QModelingElement *QUmlActionInputPin::clone() const { QUmlActionInputPin *c = new QUmlActionInputPin; @@ -134,6 +141,8 @@ QModelingElement *QUmlActionInputPin::clone() const /*! The action used to provide values. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlAction *QUmlActionInputPin::fromAction() const { @@ -142,6 +151,9 @@ QUmlAction *QUmlActionInputPin::fromAction() const return _fromAction; } +/*! + Adjusts fromAction to \a fromAction. + */ void QUmlActionInputPin::setFromAction(QUmlAction *fromAction) { // This is a read-write association end diff --git a/src/uml/qumlactioninputpin.h b/src/uml/qumlactioninputpin.h index bbc4ff37..1264a1c5 100644 --- a/src/uml/qumlactioninputpin.h +++ b/src/uml/qumlactioninputpin.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInputPin> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlActionInputPin) *) -QT_END_HEADER - #endif // QUMLACTIONINPUTPIN_H diff --git a/src/uml/qumlactivity.cpp b/src/uml/qumlactivity.cpp index b2e73f90..a016fdc8 100644 --- a/src/uml/qumlactivity.cpp +++ b/src/uml/qumlactivity.cpp @@ -97,6 +97,10 @@ QT_BEGIN_NAMESPACE \brief An activity is the specification of parameterized behavior as the coordinated sequencing of subordinate units whose individual elements are actions. */ + +/*! + Creates a new QUmlActivity. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlActivity::QUmlActivity(bool createQModelingObject) : _isReadOnly(false), _isSingleExecution(false) @@ -105,6 +109,9 @@ QUmlActivity::QUmlActivity(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlActivityObject(this)); } +/*! + Returns a deep-copied clone of the QUmlActivity. +*/ QModelingElement *QUmlActivity::clone() const { QUmlActivity *c = new QUmlActivity; @@ -202,6 +209,12 @@ QModelingElement *QUmlActivity::clone() const /*! Edges expressing flow between nodes of the activity. + + \sa addEdge(), removeEdge() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlActivityEdge::activity(). */ const QSet<QUmlActivityEdge *> QUmlActivity::edges() const { @@ -210,6 +223,11 @@ const QSet<QUmlActivityEdge *> QUmlActivity::edges() const return _edges; } +/*! + Adds \a edge to edges. + + \sa edges(), removeEdge() + */ void QUmlActivity::addEdge(QUmlActivityEdge *edge) { // This is a read-write association end @@ -230,6 +248,11 @@ void QUmlActivity::addEdge(QUmlActivityEdge *edge) } } +/*! + Removes \a edge from edges. + + \sa edges(), addEdge() + */ void QUmlActivity::removeEdge(QUmlActivityEdge *edge) { // This is a read-write association end @@ -251,6 +274,12 @@ void QUmlActivity::removeEdge(QUmlActivityEdge *edge) /*! Top-level groups in the activity. + + \sa addGroup(), removeGroup() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlActivityGroup::inActivity(). */ const QSet<QUmlActivityGroup *> QUmlActivity::groups() const { @@ -259,6 +288,11 @@ const QSet<QUmlActivityGroup *> QUmlActivity::groups() const return _groups; } +/*! + Adds \a group to groups. + + \sa groups(), removeGroup() + */ void QUmlActivity::addGroup(QUmlActivityGroup *group) { // This is a read-write association end @@ -279,6 +313,11 @@ void QUmlActivity::addGroup(QUmlActivityGroup *group) } } +/*! + Removes \a group from groups. + + \sa groups(), addGroup() + */ void QUmlActivity::removeGroup(QUmlActivityGroup *group) { // This is a read-write association end @@ -308,6 +347,9 @@ bool QUmlActivity::isReadOnly() const return _isReadOnly; } +/*! + Adjusts isReadOnly to \a isReadOnly. + */ void QUmlActivity::setReadOnly(bool isReadOnly) { // This is a read-write property @@ -328,6 +370,9 @@ bool QUmlActivity::isSingleExecution() const return _isSingleExecution; } +/*! + Adjusts isSingleExecution to \a isSingleExecution. + */ void QUmlActivity::setSingleExecution(bool isSingleExecution) { // This is a read-write property @@ -340,6 +385,12 @@ void QUmlActivity::setSingleExecution(bool isSingleExecution) /*! Nodes coordinated by the activity. + + \sa addNode(), removeNode() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlActivityNode::activity(). */ const QSet<QUmlActivityNode *> QUmlActivity::nodes() const { @@ -348,6 +399,11 @@ const QSet<QUmlActivityNode *> QUmlActivity::nodes() const return _nodes; } +/*! + Adds \a node to nodes. + + \sa nodes(), removeNode() + */ void QUmlActivity::addNode(QUmlActivityNode *node) { // This is a read-write association end @@ -368,6 +424,11 @@ void QUmlActivity::addNode(QUmlActivityNode *node) } } +/*! + Removes \a node from nodes. + + \sa nodes(), addNode() + */ void QUmlActivity::removeNode(QUmlActivityNode *node) { // This is a read-write association end @@ -389,6 +450,10 @@ void QUmlActivity::removeNode(QUmlActivityNode *node) /*! Top-level partitions in the activity. + + \sa addPartition(), removePartition() + + \b {Subsetted property(ies):} QUmlActivity::groups(). */ const QSet<QUmlActivityPartition *> QUmlActivity::partitions() const { @@ -397,6 +462,11 @@ const QSet<QUmlActivityPartition *> QUmlActivity::partitions() const return _partitions; } +/*! + Adds \a partition to partitions. + + \sa partitions(), removePartition() + */ void QUmlActivity::addPartition(QUmlActivityPartition *partition) { // This is a read-write association end @@ -411,6 +481,11 @@ void QUmlActivity::addPartition(QUmlActivityPartition *partition) } } +/*! + Removes \a partition from partitions. + + \sa partitions(), addPartition() + */ void QUmlActivity::removePartition(QUmlActivityPartition *partition) { // This is a read-write association end @@ -425,6 +500,12 @@ void QUmlActivity::removePartition(QUmlActivityPartition *partition) /*! Top-level structured nodes in the activity. + + \sa addStructuredNode(), removeStructuredNode() + + \b {Subsetted property(ies):} QUmlActivity::groups(), QUmlActivity::nodes(). + + \b {Opposite property(ies):} QUmlStructuredActivityNode::activity(). */ const QSet<QUmlStructuredActivityNode *> QUmlActivity::structuredNodes() const { @@ -433,6 +514,11 @@ const QSet<QUmlStructuredActivityNode *> QUmlActivity::structuredNodes() const return _structuredNodes; } +/*! + Adds \a structuredNode to structuredNodes. + + \sa structuredNodes(), removeStructuredNode() + */ void QUmlActivity::addStructuredNode(QUmlStructuredActivityNode *structuredNode) { // This is a read-write association end @@ -454,6 +540,11 @@ void QUmlActivity::addStructuredNode(QUmlStructuredActivityNode *structuredNode) } } +/*! + Removes \a structuredNode from structuredNodes. + + \sa structuredNodes(), addStructuredNode() + */ void QUmlActivity::removeStructuredNode(QUmlStructuredActivityNode *structuredNode) { // This is a read-write association end @@ -476,6 +567,12 @@ void QUmlActivity::removeStructuredNode(QUmlStructuredActivityNode *structuredNo /*! Top-level variables in the activity. + + \sa addVariable(), removeVariable() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlVariable::activityScope(). */ const QSet<QUmlVariable *> QUmlActivity::variables() const { @@ -484,6 +581,11 @@ const QSet<QUmlVariable *> QUmlActivity::variables() const return _variables; } +/*! + Adds \a variable to variables. + + \sa variables(), removeVariable() + */ void QUmlActivity::addVariable(QUmlVariable *variable) { // This is a read-write association end @@ -504,6 +606,11 @@ void QUmlActivity::addVariable(QUmlVariable *variable) } } +/*! + Removes \a variable from variables. + + \sa variables(), addVariable() + */ void QUmlActivity::removeVariable(QUmlVariable *variable) { // This is a read-write association end diff --git a/src/uml/qumlactivity.h b/src/uml/qumlactivity.h index d42ab105..3a8ebc4a 100644 --- a/src/uml/qumlactivity.h +++ b/src/uml/qumlactivity.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlBehavior> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -104,7 +102,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlActivity) *) -QT_END_HEADER - #endif // QUMLACTIVITY_H diff --git a/src/uml/qumlactivityedge.cpp b/src/uml/qumlactivityedge.cpp index 73b757aa..1ae5520e 100644 --- a/src/uml/qumlactivityedge.cpp +++ b/src/uml/qumlactivityedge.cpp @@ -64,7 +64,13 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief Activity edges can be contained in interruptible regions.An activity edge is an abstract class for directed connections between two activity nodes. + + \b {QUmlActivityEdge is an abstract class.} */ + +/*! + Creates a new QUmlActivityEdge. +*/ QUmlActivityEdge::QUmlActivityEdge() : _activity(0), _guard(0), @@ -76,6 +82,9 @@ QUmlActivityEdge::QUmlActivityEdge() : { } +/*! + Returns a deep-copied clone of the QUmlActivityEdge. +*/ QModelingElement *QUmlActivityEdge::clone() const { QUmlActivityEdge *c = new QUmlActivityEdge; @@ -113,6 +122,10 @@ QModelingElement *QUmlActivityEdge::clone() const /*! Activity containing the edge. + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlActivity::edges(). */ QUmlActivity *QUmlActivityEdge::activity() const { @@ -121,6 +134,9 @@ QUmlActivity *QUmlActivityEdge::activity() const return _activity; } +/*! + Adjusts activity to \a activity. + */ void QUmlActivityEdge::setActivity(QUmlActivity *activity) { // This is a read-write association end @@ -139,6 +155,8 @@ void QUmlActivityEdge::setActivity(QUmlActivity *activity) /*! Specification evaluated at runtime to determine if the edge can be traversed. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlActivityEdge::guard() const { @@ -147,6 +165,9 @@ QUmlValueSpecification *QUmlActivityEdge::guard() const return _guard; } +/*! + Adjusts guard to \a guard. + */ void QUmlActivityEdge::setGuard(QUmlValueSpecification *guard) { // This is a read-write association end @@ -169,6 +190,10 @@ void QUmlActivityEdge::setGuard(QUmlValueSpecification *guard) /*! Groups containing the edge. + + \b {This is a read-only derived union property.} + + \b {Opposite property(ies):} QUmlActivityGroup::containedEdges(). */ const QSet<QUmlActivityGroup *> QUmlActivityEdge::inGroups() const { @@ -177,6 +202,11 @@ const QSet<QUmlActivityGroup *> QUmlActivityEdge::inGroups() const return _inGroups; } +/*! + Adds \a inGroup to inGroups. + + \sa inGroups(), removeInGroup() + */ void QUmlActivityEdge::addInGroup(QUmlActivityGroup *inGroup) { // This is a read-only derived union association end @@ -193,6 +223,11 @@ void QUmlActivityEdge::addInGroup(QUmlActivityGroup *inGroup) } } +/*! + Removes \a inGroup from inGroups. + + \sa inGroups(), addInGroup() + */ void QUmlActivityEdge::removeInGroup(QUmlActivityGroup *inGroup) { // This is a read-only derived union association end @@ -209,6 +244,12 @@ void QUmlActivityEdge::removeInGroup(QUmlActivityGroup *inGroup) /*! Partitions containing the edge. + + \sa addInPartition(), removeInPartition() + + \b {Subsetted property(ies):} QUmlActivityEdge::inGroups(). + + \b {Opposite property(ies):} QUmlActivityPartition::edges(). */ const QSet<QUmlActivityPartition *> QUmlActivityEdge::inPartitions() const { @@ -217,6 +258,11 @@ const QSet<QUmlActivityPartition *> QUmlActivityEdge::inPartitions() const return _inPartitions; } +/*! + Adds \a inPartition to inPartitions. + + \sa inPartitions(), removeInPartition() + */ void QUmlActivityEdge::addInPartition(QUmlActivityPartition *inPartition) { // This is a read-write association end @@ -236,6 +282,11 @@ void QUmlActivityEdge::addInPartition(QUmlActivityPartition *inPartition) } } +/*! + Removes \a inPartition from inPartitions. + + \sa inPartitions(), addInPartition() + */ void QUmlActivityEdge::removeInPartition(QUmlActivityPartition *inPartition) { // This is a read-write association end @@ -255,6 +306,10 @@ void QUmlActivityEdge::removeInPartition(QUmlActivityPartition *inPartition) /*! Structured activity node containing the edge. + + \b {Subsetted property(ies):} QUmlActivityEdge::inGroups(), QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlStructuredActivityNode::edges(). */ QUmlStructuredActivityNode *QUmlActivityEdge::inStructuredNode() const { @@ -263,6 +318,9 @@ QUmlStructuredActivityNode *QUmlActivityEdge::inStructuredNode() const return _inStructuredNode; } +/*! + Adjusts inStructuredNode to \a inStructuredNode. + */ void QUmlActivityEdge::setInStructuredNode(QUmlStructuredActivityNode *inStructuredNode) { // This is a read-write association end @@ -285,6 +343,8 @@ void QUmlActivityEdge::setInStructuredNode(QUmlStructuredActivityNode *inStructu /*! Region that the edge can interrupt. + + \b {Opposite property(ies):} QUmlInterruptibleActivityRegion::interruptingEdges(). */ QUmlInterruptibleActivityRegion *QUmlActivityEdge::interrupts() const { @@ -293,6 +353,9 @@ QUmlInterruptibleActivityRegion *QUmlActivityEdge::interrupts() const return _interrupts; } +/*! + Adjusts interrupts to \a interrupts. + */ void QUmlActivityEdge::setInterrupts(QUmlInterruptibleActivityRegion *interrupts) { // This is a read-write association end @@ -306,6 +369,10 @@ void QUmlActivityEdge::setInterrupts(QUmlInterruptibleActivityRegion *interrupts /*! Inherited edges replaced by this edge in a specialization of the activity. + + \sa addRedefinedEdge(), removeRedefinedEdge() + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinedElements(). */ const QSet<QUmlActivityEdge *> QUmlActivityEdge::redefinedEdges() const { @@ -314,6 +381,11 @@ const QSet<QUmlActivityEdge *> QUmlActivityEdge::redefinedEdges() const return _redefinedEdges; } +/*! + Adds \a redefinedEdge to redefinedEdges. + + \sa redefinedEdges(), removeRedefinedEdge() + */ void QUmlActivityEdge::addRedefinedEdge(QUmlActivityEdge *redefinedEdge) { // This is a read-write association end @@ -328,6 +400,11 @@ void QUmlActivityEdge::addRedefinedEdge(QUmlActivityEdge *redefinedEdge) } } +/*! + Removes \a redefinedEdge from redefinedEdges. + + \sa redefinedEdges(), addRedefinedEdge() + */ void QUmlActivityEdge::removeRedefinedEdge(QUmlActivityEdge *redefinedEdge) { // This is a read-write association end @@ -342,6 +419,8 @@ void QUmlActivityEdge::removeRedefinedEdge(QUmlActivityEdge *redefinedEdge) /*! Node from which tokens are taken when they traverse the edge. + + \b {Opposite property(ies):} QUmlActivityNode::outgoings(). */ QUmlActivityNode *QUmlActivityEdge::source() const { @@ -350,6 +429,9 @@ QUmlActivityNode *QUmlActivityEdge::source() const return _source; } +/*! + Adjusts source to \a source. + */ void QUmlActivityEdge::setSource(QUmlActivityNode *source) { // This is a read-write association end @@ -363,6 +445,8 @@ void QUmlActivityEdge::setSource(QUmlActivityNode *source) /*! Node to which tokens are put when they traverse the edge. + + \b {Opposite property(ies):} QUmlActivityNode::incomings(). */ QUmlActivityNode *QUmlActivityEdge::target() const { @@ -371,6 +455,9 @@ QUmlActivityNode *QUmlActivityEdge::target() const return _target; } +/*! + Adjusts target to \a target. + */ void QUmlActivityEdge::setTarget(QUmlActivityNode *target) { // This is a read-write association end @@ -384,6 +471,8 @@ void QUmlActivityEdge::setTarget(QUmlActivityNode *target) /*! The minimum number of tokens that must traverse the edge at the same time. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlActivityEdge::weight() const { @@ -392,6 +481,9 @@ QUmlValueSpecification *QUmlActivityEdge::weight() const return _weight; } +/*! + Adjusts weight to \a weight. + */ void QUmlActivityEdge::setWeight(QUmlValueSpecification *weight) { // This is a read-write association end diff --git a/src/uml/qumlactivityedge.h b/src/uml/qumlactivityedge.h index 82004e4b..89989b44 100644 --- a/src/uml/qumlactivityedge.h +++ b/src/uml/qumlactivityedge.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlRedefinableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -108,7 +106,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlActivityEdge) *) -QT_END_HEADER - #endif // QUMLACTIVITYEDGE_H diff --git a/src/uml/qumlactivityfinalnode.cpp b/src/uml/qumlactivityfinalnode.cpp index e2abe383..d97915d6 100644 --- a/src/uml/qumlactivityfinalnode.cpp +++ b/src/uml/qumlactivityfinalnode.cpp @@ -68,12 +68,19 @@ QT_BEGIN_NAMESPACE \brief An activity final node is a final node that stops all flows in an activity. */ + +/*! + Creates a new QUmlActivityFinalNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlActivityFinalNode::QUmlActivityFinalNode(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlActivityFinalNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlActivityFinalNode. +*/ QModelingElement *QUmlActivityFinalNode::clone() const { QUmlActivityFinalNode *c = new QUmlActivityFinalNode; diff --git a/src/uml/qumlactivityfinalnode.h b/src/uml/qumlactivityfinalnode.h index 90be09f1..0a46e7af 100644 --- a/src/uml/qumlactivityfinalnode.h +++ b/src/uml/qumlactivityfinalnode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlFinalNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlActivityFinalNode) *) -QT_END_HEADER - #endif // QUMLACTIVITYFINALNODE_H diff --git a/src/uml/qumlactivitygroup.cpp b/src/uml/qumlactivitygroup.cpp index 98dafc72..f59da474 100644 --- a/src/uml/qumlactivitygroup.cpp +++ b/src/uml/qumlactivitygroup.cpp @@ -58,13 +58,22 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief ActivityGroup is an abstract class for defining sets of nodes and edges in an activity. + + \b {QUmlActivityGroup is an abstract class.} */ + +/*! + Creates a new QUmlActivityGroup. +*/ QUmlActivityGroup::QUmlActivityGroup() : _inActivity(0), _superGroup(0) { } +/*! + Returns a deep-copied clone of the QUmlActivityGroup. +*/ QModelingElement *QUmlActivityGroup::clone() const { QUmlActivityGroup *c = new QUmlActivityGroup; @@ -85,6 +94,10 @@ QModelingElement *QUmlActivityGroup::clone() const /*! Edges immediately contained in the group. + + \b {This is a read-only derived union property.} + + \b {Opposite property(ies):} QUmlActivityEdge::inGroups(). */ const QSet<QUmlActivityEdge *> QUmlActivityGroup::containedEdges() const { @@ -93,6 +106,11 @@ const QSet<QUmlActivityEdge *> QUmlActivityGroup::containedEdges() const return _containedEdges; } +/*! + Adds \a containedEdge to containedEdges. + + \sa containedEdges(), removeContainedEdge() + */ void QUmlActivityGroup::addContainedEdge(QUmlActivityEdge *containedEdge) { // This is a read-only derived union association end @@ -109,6 +127,11 @@ void QUmlActivityGroup::addContainedEdge(QUmlActivityEdge *containedEdge) } } +/*! + Removes \a containedEdge from containedEdges. + + \sa containedEdges(), addContainedEdge() + */ void QUmlActivityGroup::removeContainedEdge(QUmlActivityEdge *containedEdge) { // This is a read-only derived union association end @@ -125,6 +148,10 @@ void QUmlActivityGroup::removeContainedEdge(QUmlActivityEdge *containedEdge) /*! Nodes immediately contained in the group. + + \b {This is a read-only derived union property.} + + \b {Opposite property(ies):} QUmlActivityNode::inGroups(). */ const QSet<QUmlActivityNode *> QUmlActivityGroup::containedNodes() const { @@ -133,6 +160,11 @@ const QSet<QUmlActivityNode *> QUmlActivityGroup::containedNodes() const return _containedNodes; } +/*! + Adds \a containedNode to containedNodes. + + \sa containedNodes(), removeContainedNode() + */ void QUmlActivityGroup::addContainedNode(QUmlActivityNode *containedNode) { // This is a read-only derived union association end @@ -149,6 +181,11 @@ void QUmlActivityGroup::addContainedNode(QUmlActivityNode *containedNode) } } +/*! + Removes \a containedNode from containedNodes. + + \sa containedNodes(), addContainedNode() + */ void QUmlActivityGroup::removeContainedNode(QUmlActivityNode *containedNode) { // This is a read-only derived union association end @@ -165,6 +202,10 @@ void QUmlActivityGroup::removeContainedNode(QUmlActivityNode *containedNode) /*! Activity containing the group. + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlActivity::groups(). */ QUmlActivity *QUmlActivityGroup::inActivity() const { @@ -173,6 +214,9 @@ QUmlActivity *QUmlActivityGroup::inActivity() const return _inActivity; } +/*! + Adjusts inActivity to \a inActivity. + */ void QUmlActivityGroup::setInActivity(QUmlActivity *inActivity) { // This is a read-write association end @@ -191,6 +235,12 @@ void QUmlActivityGroup::setInActivity(QUmlActivity *inActivity) /*! Groups immediately contained in the group. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlActivityGroup::superGroup(). */ const QSet<QUmlActivityGroup *> QUmlActivityGroup::subgroups() const { @@ -199,6 +249,11 @@ const QSet<QUmlActivityGroup *> QUmlActivityGroup::subgroups() const return _subgroups; } +/*! + Adds \a subgroup to subgroups. + + \sa subgroups(), removeSubgroup() + */ void QUmlActivityGroup::addSubgroup(QUmlActivityGroup *subgroup) { // This is a read-only derived union association end @@ -219,6 +274,11 @@ void QUmlActivityGroup::addSubgroup(QUmlActivityGroup *subgroup) } } +/*! + Removes \a subgroup from subgroups. + + \sa subgroups(), addSubgroup() + */ void QUmlActivityGroup::removeSubgroup(QUmlActivityGroup *subgroup) { // This is a read-only derived union association end @@ -240,6 +300,12 @@ void QUmlActivityGroup::removeSubgroup(QUmlActivityGroup *subgroup) /*! Group immediately containing the group. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlActivityGroup::subgroups(). */ QUmlActivityGroup *QUmlActivityGroup::superGroup() const { @@ -248,6 +314,9 @@ QUmlActivityGroup *QUmlActivityGroup::superGroup() const return _superGroup; } +/*! + Adjusts superGroup to \a superGroup. + */ void QUmlActivityGroup::setSuperGroup(QUmlActivityGroup *superGroup) { // This is a read-only derived union association end diff --git a/src/uml/qumlactivitygroup.h b/src/uml/qumlactivitygroup.h index 7fefc24a..01440943 100644 --- a/src/uml/qumlactivitygroup.h +++ b/src/uml/qumlactivitygroup.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -89,7 +87,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlActivityGroup) *) -QT_END_HEADER - #endif // QUMLACTIVITYGROUP_H diff --git a/src/uml/qumlactivitynode.cpp b/src/uml/qumlactivitynode.cpp index 0ca95656..cde25139 100644 --- a/src/uml/qumlactivitynode.cpp +++ b/src/uml/qumlactivitynode.cpp @@ -63,13 +63,22 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief ActivityNode is an abstract class for points in the flow of an activity connected by edges. + + \b {QUmlActivityNode is an abstract class.} */ + +/*! + Creates a new QUmlActivityNode. +*/ QUmlActivityNode::QUmlActivityNode() : _activity(0), _inStructuredNode(0) { } +/*! + Returns a deep-copied clone of the QUmlActivityNode. +*/ QModelingElement *QUmlActivityNode::clone() const { QUmlActivityNode *c = new QUmlActivityNode; @@ -103,6 +112,10 @@ QModelingElement *QUmlActivityNode::clone() const /*! Activity containing the node. + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlActivity::nodes(). */ QUmlActivity *QUmlActivityNode::activity() const { @@ -111,6 +124,9 @@ QUmlActivity *QUmlActivityNode::activity() const return _activity; } +/*! + Adjusts activity to \a activity. + */ void QUmlActivityNode::setActivity(QUmlActivity *activity) { // This is a read-write association end @@ -129,6 +145,10 @@ void QUmlActivityNode::setActivity(QUmlActivity *activity) /*! Groups containing the node. + + \b {This is a read-only derived union property.} + + \b {Opposite property(ies):} QUmlActivityGroup::containedNodes(). */ const QSet<QUmlActivityGroup *> QUmlActivityNode::inGroups() const { @@ -137,6 +157,11 @@ const QSet<QUmlActivityGroup *> QUmlActivityNode::inGroups() const return _inGroups; } +/*! + Adds \a inGroup to inGroups. + + \sa inGroups(), removeInGroup() + */ void QUmlActivityNode::addInGroup(QUmlActivityGroup *inGroup) { // This is a read-only derived union association end @@ -153,6 +178,11 @@ void QUmlActivityNode::addInGroup(QUmlActivityGroup *inGroup) } } +/*! + Removes \a inGroup from inGroups. + + \sa inGroups(), addInGroup() + */ void QUmlActivityNode::removeInGroup(QUmlActivityGroup *inGroup) { // This is a read-only derived union association end @@ -169,6 +199,12 @@ void QUmlActivityNode::removeInGroup(QUmlActivityGroup *inGroup) /*! Interruptible regions containing the node. + + \sa addInInterruptibleRegion(), removeInInterruptibleRegion() + + \b {Subsetted property(ies):} QUmlActivityNode::inGroups(). + + \b {Opposite property(ies):} QUmlInterruptibleActivityRegion::nodes(). */ const QSet<QUmlInterruptibleActivityRegion *> QUmlActivityNode::inInterruptibleRegions() const { @@ -177,6 +213,11 @@ const QSet<QUmlInterruptibleActivityRegion *> QUmlActivityNode::inInterruptibleR return _inInterruptibleRegions; } +/*! + Adds \a inInterruptibleRegion to inInterruptibleRegions. + + \sa inInterruptibleRegions(), removeInInterruptibleRegion() + */ void QUmlActivityNode::addInInterruptibleRegion(QUmlInterruptibleActivityRegion *inInterruptibleRegion) { // This is a read-write association end @@ -196,6 +237,11 @@ void QUmlActivityNode::addInInterruptibleRegion(QUmlInterruptibleActivityRegion } } +/*! + Removes \a inInterruptibleRegion from inInterruptibleRegions. + + \sa inInterruptibleRegions(), addInInterruptibleRegion() + */ void QUmlActivityNode::removeInInterruptibleRegion(QUmlInterruptibleActivityRegion *inInterruptibleRegion) { // This is a read-write association end @@ -215,6 +261,12 @@ void QUmlActivityNode::removeInInterruptibleRegion(QUmlInterruptibleActivityRegi /*! Partitions containing the node. + + \sa addInPartition(), removeInPartition() + + \b {Subsetted property(ies):} QUmlActivityNode::inGroups(). + + \b {Opposite property(ies):} QUmlActivityPartition::nodes(). */ const QSet<QUmlActivityPartition *> QUmlActivityNode::inPartitions() const { @@ -223,6 +275,11 @@ const QSet<QUmlActivityPartition *> QUmlActivityNode::inPartitions() const return _inPartitions; } +/*! + Adds \a inPartition to inPartitions. + + \sa inPartitions(), removeInPartition() + */ void QUmlActivityNode::addInPartition(QUmlActivityPartition *inPartition) { // This is a read-write association end @@ -242,6 +299,11 @@ void QUmlActivityNode::addInPartition(QUmlActivityPartition *inPartition) } } +/*! + Removes \a inPartition from inPartitions. + + \sa inPartitions(), addInPartition() + */ void QUmlActivityNode::removeInPartition(QUmlActivityPartition *inPartition) { // This is a read-write association end @@ -261,6 +323,10 @@ void QUmlActivityNode::removeInPartition(QUmlActivityPartition *inPartition) /*! Structured activity node containing the node. + + \b {Subsetted property(ies):} QUmlActivityNode::inGroups(), QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlStructuredActivityNode::nodes(). */ QUmlStructuredActivityNode *QUmlActivityNode::inStructuredNode() const { @@ -269,6 +335,9 @@ QUmlStructuredActivityNode *QUmlActivityNode::inStructuredNode() const return _inStructuredNode; } +/*! + Adjusts inStructuredNode to \a inStructuredNode. + */ void QUmlActivityNode::setInStructuredNode(QUmlStructuredActivityNode *inStructuredNode) { // This is a read-write association end @@ -291,6 +360,10 @@ void QUmlActivityNode::setInStructuredNode(QUmlStructuredActivityNode *inStructu /*! Edges that have the node as target. + + \sa addIncoming(), removeIncoming() + + \b {Opposite property(ies):} QUmlActivityEdge::target(). */ const QSet<QUmlActivityEdge *> QUmlActivityNode::incomings() const { @@ -299,6 +372,11 @@ const QSet<QUmlActivityEdge *> QUmlActivityNode::incomings() const return _incomings; } +/*! + Adds \a incoming to incomings. + + \sa incomings(), removeIncoming() + */ void QUmlActivityNode::addIncoming(QUmlActivityEdge *incoming) { // This is a read-write association end @@ -315,6 +393,11 @@ void QUmlActivityNode::addIncoming(QUmlActivityEdge *incoming) } } +/*! + Removes \a incoming from incomings. + + \sa incomings(), addIncoming() + */ void QUmlActivityNode::removeIncoming(QUmlActivityEdge *incoming) { // This is a read-write association end @@ -331,6 +414,10 @@ void QUmlActivityNode::removeIncoming(QUmlActivityEdge *incoming) /*! Edges that have the node as source. + + \sa addOutgoing(), removeOutgoing() + + \b {Opposite property(ies):} QUmlActivityEdge::source(). */ const QSet<QUmlActivityEdge *> QUmlActivityNode::outgoings() const { @@ -339,6 +426,11 @@ const QSet<QUmlActivityEdge *> QUmlActivityNode::outgoings() const return _outgoings; } +/*! + Adds \a outgoing to outgoings. + + \sa outgoings(), removeOutgoing() + */ void QUmlActivityNode::addOutgoing(QUmlActivityEdge *outgoing) { // This is a read-write association end @@ -355,6 +447,11 @@ void QUmlActivityNode::addOutgoing(QUmlActivityEdge *outgoing) } } +/*! + Removes \a outgoing from outgoings. + + \sa outgoings(), addOutgoing() + */ void QUmlActivityNode::removeOutgoing(QUmlActivityEdge *outgoing) { // This is a read-write association end @@ -371,6 +468,10 @@ void QUmlActivityNode::removeOutgoing(QUmlActivityEdge *outgoing) /*! Inherited nodes replaced by this node in a specialization of the activity. + + \sa addRedefinedNode(), removeRedefinedNode() + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinedElements(). */ const QSet<QUmlActivityNode *> QUmlActivityNode::redefinedNodes() const { @@ -379,6 +480,11 @@ const QSet<QUmlActivityNode *> QUmlActivityNode::redefinedNodes() const return _redefinedNodes; } +/*! + Adds \a redefinedNode to redefinedNodes. + + \sa redefinedNodes(), removeRedefinedNode() + */ void QUmlActivityNode::addRedefinedNode(QUmlActivityNode *redefinedNode) { // This is a read-write association end @@ -393,6 +499,11 @@ void QUmlActivityNode::addRedefinedNode(QUmlActivityNode *redefinedNode) } } +/*! + Removes \a redefinedNode from redefinedNodes. + + \sa redefinedNodes(), addRedefinedNode() + */ void QUmlActivityNode::removeRedefinedNode(QUmlActivityNode *redefinedNode) { // This is a read-write association end diff --git a/src/uml/qumlactivitynode.h b/src/uml/qumlactivitynode.h index d88c87a6..007787f6 100644 --- a/src/uml/qumlactivitynode.h +++ b/src/uml/qumlactivitynode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlRedefinableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -104,7 +102,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlActivityNode) *) -QT_END_HEADER - #endif // QUMLACTIVITYNODE_H diff --git a/src/uml/qumlactivityparameternode.cpp b/src/uml/qumlactivityparameternode.cpp index 54d79708..96958c66 100644 --- a/src/uml/qumlactivityparameternode.cpp +++ b/src/uml/qumlactivityparameternode.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief An activity parameter node is an object node for inputs and outputs to activities. */ + +/*! + Creates a new QUmlActivityParameterNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlActivityParameterNode::QUmlActivityParameterNode(bool createQModelingObject) : _parameter(0) { @@ -80,6 +84,9 @@ QUmlActivityParameterNode::QUmlActivityParameterNode(bool createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlActivityParameterNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlActivityParameterNode. +*/ QModelingElement *QUmlActivityParameterNode::clone() const { QUmlActivityParameterNode *c = new QUmlActivityParameterNode; @@ -133,6 +140,9 @@ QUmlParameter *QUmlActivityParameterNode::parameter() const return _parameter; } +/*! + Adjusts parameter to \a parameter. + */ void QUmlActivityParameterNode::setParameter(QUmlParameter *parameter) { // This is a read-write association end diff --git a/src/uml/qumlactivityparameternode.h b/src/uml/qumlactivityparameternode.h index 3bf9a25c..a0457c65 100644 --- a/src/uml/qumlactivityparameternode.h +++ b/src/uml/qumlactivityparameternode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlObjectNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlActivityParameterNode) *) -QT_END_HEADER - #endif // QUMLACTIVITYPARAMETERNODE_H diff --git a/src/uml/qumlactivitypartition.cpp b/src/uml/qumlactivitypartition.cpp index 689d729d..bb5fb307 100644 --- a/src/uml/qumlactivitypartition.cpp +++ b/src/uml/qumlactivitypartition.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief An activity partition is a kind of activity group for identifying actions that have some characteristic in common. */ + +/*! + Creates a new QUmlActivityPartition. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlActivityPartition::QUmlActivityPartition(bool createQModelingObject) : _isDimension(false), _isExternal(false), @@ -72,6 +76,9 @@ QUmlActivityPartition::QUmlActivityPartition(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlActivityPartitionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlActivityPartition. +*/ QModelingElement *QUmlActivityPartition::clone() const { QUmlActivityPartition *c = new QUmlActivityPartition; @@ -104,6 +111,12 @@ QModelingElement *QUmlActivityPartition::clone() const /*! Edges immediately contained in the group. + + \sa addEdge(), removeEdge() + + \b {Subsetted property(ies):} QUmlActivityGroup::containedEdges(). + + \b {Opposite property(ies):} QUmlActivityEdge::inPartitions(). */ const QSet<QUmlActivityEdge *> QUmlActivityPartition::edges() const { @@ -112,6 +125,11 @@ const QSet<QUmlActivityEdge *> QUmlActivityPartition::edges() const return _edges; } +/*! + Adds \a edge to edges. + + \sa edges(), removeEdge() + */ void QUmlActivityPartition::addEdge(QUmlActivityEdge *edge) { // This is a read-write association end @@ -131,6 +149,11 @@ void QUmlActivityPartition::addEdge(QUmlActivityEdge *edge) } } +/*! + Removes \a edge from edges. + + \sa edges(), addEdge() + */ void QUmlActivityPartition::removeEdge(QUmlActivityEdge *edge) { // This is a read-write association end @@ -158,6 +181,9 @@ bool QUmlActivityPartition::isDimension() const return _isDimension; } +/*! + Adjusts isDimension to \a isDimension. + */ void QUmlActivityPartition::setDimension(bool isDimension) { // This is a read-write property @@ -178,6 +204,9 @@ bool QUmlActivityPartition::isExternal() const return _isExternal; } +/*! + Adjusts isExternal to \a isExternal. + */ void QUmlActivityPartition::setExternal(bool isExternal) { // This is a read-write property @@ -190,6 +219,12 @@ void QUmlActivityPartition::setExternal(bool isExternal) /*! Nodes immediately contained in the group. + + \sa addNode(), removeNode() + + \b {Subsetted property(ies):} QUmlActivityGroup::containedNodes(). + + \b {Opposite property(ies):} QUmlActivityNode::inPartitions(). */ const QSet<QUmlActivityNode *> QUmlActivityPartition::nodes() const { @@ -198,6 +233,11 @@ const QSet<QUmlActivityNode *> QUmlActivityPartition::nodes() const return _nodes; } +/*! + Adds \a node to nodes. + + \sa nodes(), removeNode() + */ void QUmlActivityPartition::addNode(QUmlActivityNode *node) { // This is a read-write association end @@ -217,6 +257,11 @@ void QUmlActivityPartition::addNode(QUmlActivityNode *node) } } +/*! + Removes \a node from nodes. + + \sa nodes(), addNode() + */ void QUmlActivityPartition::removeNode(QUmlActivityNode *node) { // This is a read-write association end @@ -244,6 +289,9 @@ QUmlElement *QUmlActivityPartition::represents() const return _represents; } +/*! + Adjusts represents to \a represents. + */ void QUmlActivityPartition::setRepresents(QUmlElement *represents) { // This is a read-write association end @@ -257,6 +305,12 @@ void QUmlActivityPartition::setRepresents(QUmlElement *represents) /*! Partitions immediately contained in the partition. + + \sa addSubpartition(), removeSubpartition() + + \b {Subsetted property(ies):} QUmlActivityGroup::subgroups(). + + \b {Opposite property(ies):} QUmlActivityPartition::superPartition(). */ const QSet<QUmlActivityPartition *> QUmlActivityPartition::subpartitions() const { @@ -265,6 +319,11 @@ const QSet<QUmlActivityPartition *> QUmlActivityPartition::subpartitions() const return _subpartitions; } +/*! + Adds \a subpartition to subpartitions. + + \sa subpartitions(), removeSubpartition() + */ void QUmlActivityPartition::addSubpartition(QUmlActivityPartition *subpartition) { // This is a read-write association end @@ -285,6 +344,11 @@ void QUmlActivityPartition::addSubpartition(QUmlActivityPartition *subpartition) } } +/*! + Removes \a subpartition from subpartitions. + + \sa subpartitions(), addSubpartition() + */ void QUmlActivityPartition::removeSubpartition(QUmlActivityPartition *subpartition) { // This is a read-write association end @@ -306,6 +370,10 @@ void QUmlActivityPartition::removeSubpartition(QUmlActivityPartition *subpartiti /*! Partition immediately containing the partition. + + \b {Subsetted property(ies):} QUmlActivityGroup::superGroup(). + + \b {Opposite property(ies):} QUmlActivityPartition::subpartitions(). */ QUmlActivityPartition *QUmlActivityPartition::superPartition() const { @@ -314,6 +382,9 @@ QUmlActivityPartition *QUmlActivityPartition::superPartition() const return _superPartition; } +/*! + Adjusts superPartition to \a superPartition. + */ void QUmlActivityPartition::setSuperPartition(QUmlActivityPartition *superPartition) { // This is a read-write association end diff --git a/src/uml/qumlactivitypartition.h b/src/uml/qumlactivitypartition.h index 3be3b807..f4a348d3 100644 --- a/src/uml/qumlactivitypartition.h +++ b/src/uml/qumlactivitypartition.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlActivityGroup> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -95,7 +93,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlActivityPartition) *) -QT_END_HEADER - #endif // QUMLACTIVITYPARTITION_H diff --git a/src/uml/qumlactor.cpp b/src/uml/qumlactor.cpp index f26537c5..bc95d9ac 100644 --- a/src/uml/qumlactor.cpp +++ b/src/uml/qumlactor.cpp @@ -81,12 +81,19 @@ QT_BEGIN_NAMESPACE \brief An actor specifies a role played by a user or any other system that interacts with the subject. */ + +/*! + Creates a new QUmlActor. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlActor::QUmlActor(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlActorObject(this)); } +/*! + Returns a deep-copied clone of the QUmlActor. +*/ QModelingElement *QUmlActor::clone() const { QUmlActor *c = new QUmlActor; diff --git a/src/uml/qumlactor.h b/src/uml/qumlactor.h index b1f401f9..0052d428 100644 --- a/src/uml/qumlactor.h +++ b/src/uml/qumlactor.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlBehavioredClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlActor) *) -QT_END_HEADER - #endif // QUMLACTOR_H diff --git a/src/uml/qumladdstructuralfeaturevalueaction.cpp b/src/uml/qumladdstructuralfeaturevalueaction.cpp index 28b848af..d1ef77fb 100644 --- a/src/uml/qumladdstructuralfeaturevalueaction.cpp +++ b/src/uml/qumladdstructuralfeaturevalueaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief An add structural feature value action is a write structural feature action for adding values to a structural feature. */ + +/*! + Creates a new QUmlAddStructuralFeatureValueAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlAddStructuralFeatureValueAction::QUmlAddStructuralFeatureValueAction(bool createQModelingObject) : _insertAt(0), _isReplaceAll(false) @@ -81,6 +85,9 @@ QUmlAddStructuralFeatureValueAction::QUmlAddStructuralFeatureValueAction(bool cr _qModelingObject = qobject_cast<QModelingObject *>(new QUmlAddStructuralFeatureValueActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlAddStructuralFeatureValueAction. +*/ QModelingElement *QUmlAddStructuralFeatureValueAction::clone() const { QUmlAddStructuralFeatureValueAction *c = new QUmlAddStructuralFeatureValueAction; @@ -132,6 +139,8 @@ QModelingElement *QUmlAddStructuralFeatureValueAction::clone() const /*! Gives the position at which to insert a new value or move an existing value in ordered structural features. The type of the pin is UnlimitedNatural, but the value cannot be zero. This pin is omitted for unordered structural features. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlAddStructuralFeatureValueAction::insertAt() const { @@ -140,6 +149,9 @@ QUmlInputPin *QUmlAddStructuralFeatureValueAction::insertAt() const return _insertAt; } +/*! + Adjusts insertAt to \a insertAt. + */ void QUmlAddStructuralFeatureValueAction::setInsertAt(QUmlInputPin *insertAt) { // This is a read-write association end @@ -170,6 +182,9 @@ bool QUmlAddStructuralFeatureValueAction::isReplaceAll() const return _isReplaceAll; } +/*! + Adjusts isReplaceAll to \a isReplaceAll. + */ void QUmlAddStructuralFeatureValueAction::setReplaceAll(bool isReplaceAll) { // This is a read-write property diff --git a/src/uml/qumladdstructuralfeaturevalueaction.h b/src/uml/qumladdstructuralfeaturevalueaction.h index ad5636ed..fca95f09 100644 --- a/src/uml/qumladdstructuralfeaturevalueaction.h +++ b/src/uml/qumladdstructuralfeaturevalueaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlWriteStructuralFeatureAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlAddStructuralFeatureValueAction) *) -QT_END_HEADER - #endif // QUMLADDSTRUCTURALFEATUREVALUEACTION_H diff --git a/src/uml/qumladdvariablevalueaction.cpp b/src/uml/qumladdvariablevalueaction.cpp index 7e6da280..cb3848de 100644 --- a/src/uml/qumladdvariablevalueaction.cpp +++ b/src/uml/qumladdvariablevalueaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief An add variable value action is a write variable action for adding values to a variable. */ + +/*! + Creates a new QUmlAddVariableValueAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlAddVariableValueAction::QUmlAddVariableValueAction(bool createQModelingObject) : _insertAt(0), _isReplaceAll(false) @@ -81,6 +85,9 @@ QUmlAddVariableValueAction::QUmlAddVariableValueAction(bool createQModelingObjec _qModelingObject = qobject_cast<QModelingObject *>(new QUmlAddVariableValueActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlAddVariableValueAction. +*/ QModelingElement *QUmlAddVariableValueAction::clone() const { QUmlAddVariableValueAction *c = new QUmlAddVariableValueAction; @@ -128,6 +135,8 @@ QModelingElement *QUmlAddVariableValueAction::clone() const /*! Gives the position at which to insert a new value or move an existing value in ordered variables. The types is UnlimitedINatural, but the value cannot be zero. This pin is omitted for unordered variables. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlAddVariableValueAction::insertAt() const { @@ -136,6 +145,9 @@ QUmlInputPin *QUmlAddVariableValueAction::insertAt() const return _insertAt; } +/*! + Adjusts insertAt to \a insertAt. + */ void QUmlAddVariableValueAction::setInsertAt(QUmlInputPin *insertAt) { // This is a read-write association end @@ -166,6 +178,9 @@ bool QUmlAddVariableValueAction::isReplaceAll() const return _isReplaceAll; } +/*! + Adjusts isReplaceAll to \a isReplaceAll. + */ void QUmlAddVariableValueAction::setReplaceAll(bool isReplaceAll) { // This is a read-write property diff --git a/src/uml/qumladdvariablevalueaction.h b/src/uml/qumladdvariablevalueaction.h index 2d1cdd6c..20148b58 100644 --- a/src/uml/qumladdvariablevalueaction.h +++ b/src/uml/qumladdvariablevalueaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlWriteVariableAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlAddVariableValueAction) *) -QT_END_HEADER - #endif // QUMLADDVARIABLEVALUEACTION_H diff --git a/src/uml/qumlanyreceiveevent.cpp b/src/uml/qumlanyreceiveevent.cpp index c610a6c6..5f3ffa7d 100644 --- a/src/uml/qumlanyreceiveevent.cpp +++ b/src/uml/qumlanyreceiveevent.cpp @@ -61,12 +61,19 @@ QT_BEGIN_NAMESPACE \brief A trigger for an AnyReceiveEvent is triggered by the receipt of any message that is not explicitly handled by any related trigger. */ + +/*! + Creates a new QUmlAnyReceiveEvent. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlAnyReceiveEvent::QUmlAnyReceiveEvent(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlAnyReceiveEventObject(this)); } +/*! + Returns a deep-copied clone of the QUmlAnyReceiveEvent. +*/ QModelingElement *QUmlAnyReceiveEvent::clone() const { QUmlAnyReceiveEvent *c = new QUmlAnyReceiveEvent; diff --git a/src/uml/qumlanyreceiveevent.h b/src/uml/qumlanyreceiveevent.h index 5aabbff8..9fe874d7 100644 --- a/src/uml/qumlanyreceiveevent.h +++ b/src/uml/qumlanyreceiveevent.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlMessageEvent> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlAnyReceiveEvent) *) -QT_END_HEADER - #endif // QUMLANYRECEIVEEVENT_H diff --git a/src/uml/qumlartifact.cpp b/src/uml/qumlartifact.cpp index 563d48fb..8fd989d7 100644 --- a/src/uml/qumlartifact.cpp +++ b/src/uml/qumlartifact.cpp @@ -80,12 +80,19 @@ QT_BEGIN_NAMESPACE \brief An artifact is the source of a deployment to a node.An artifact is the specification of a physical piece of information that is used or produced by a software development process, or by deployment and operation of a system. Examples of artifacts include model files, source files, scripts, and binary executable files, a table in a database system, a development deliverable, or a word-processing document, a mail message. */ + +/*! + Creates a new QUmlArtifact. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlArtifact::QUmlArtifact(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlArtifactObject(this)); } +/*! + Returns a deep-copied clone of the QUmlArtifact. +*/ QModelingElement *QUmlArtifact::clone() const { QUmlArtifact *c = new QUmlArtifact; @@ -156,6 +163,9 @@ QString QUmlArtifact::fileName() const return _fileName; } +/*! + Adjusts fileName to \a fileName. + */ void QUmlArtifact::setFileName(QString fileName) { // This is a read-write property @@ -167,6 +177,10 @@ void QUmlArtifact::setFileName(QString fileName) /*! The set of model elements that are manifested in the Artifact. That is, these model elements are utilized in the construction (or generation) of the artifact. + + \sa addManifestation(), removeManifestation() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(), QUmlNamedElement::clientDependencies(). */ const QSet<QUmlManifestation *> QUmlArtifact::manifestations() const { @@ -175,6 +189,11 @@ const QSet<QUmlManifestation *> QUmlArtifact::manifestations() const return _manifestations; } +/*! + Adds \a manifestation to manifestations. + + \sa manifestations(), removeManifestation() + */ void QUmlArtifact::addManifestation(QUmlManifestation *manifestation) { // This is a read-write association end @@ -191,6 +210,11 @@ void QUmlArtifact::addManifestation(QUmlManifestation *manifestation) } } +/*! + Removes \a manifestation from manifestations. + + \sa manifestations(), addManifestation() + */ void QUmlArtifact::removeManifestation(QUmlManifestation *manifestation) { // This is a read-write association end @@ -208,6 +232,10 @@ void QUmlArtifact::removeManifestation(QUmlManifestation *manifestation) /*! The Artifacts that are defined (nested) within the Artifact. The association is a specialization of the ownedMember association from Namespace to NamedElement. + + \sa addNestedArtifact(), removeNestedArtifact() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QSet<QUmlArtifact *> QUmlArtifact::nestedArtifacts() const { @@ -216,6 +244,11 @@ const QSet<QUmlArtifact *> QUmlArtifact::nestedArtifacts() const return _nestedArtifacts; } +/*! + Adds \a nestedArtifact to nestedArtifacts. + + \sa nestedArtifacts(), removeNestedArtifact() + */ void QUmlArtifact::addNestedArtifact(QUmlArtifact *nestedArtifact) { // This is a read-write association end @@ -231,6 +264,11 @@ void QUmlArtifact::addNestedArtifact(QUmlArtifact *nestedArtifact) } } +/*! + Removes \a nestedArtifact from nestedArtifacts. + + \sa nestedArtifacts(), addNestedArtifact() + */ void QUmlArtifact::removeNestedArtifact(QUmlArtifact *nestedArtifact) { // This is a read-write association end @@ -247,6 +285,10 @@ void QUmlArtifact::removeNestedArtifact(QUmlArtifact *nestedArtifact) /*! The attributes or association ends defined for the Artifact. The association is a specialization of the ownedMember association. + + \sa addOwnedAttribute(), removeOwnedAttribute() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(), QUmlClassifier::attributes(). */ const QList<QUmlProperty *> QUmlArtifact::ownedAttributes() const { @@ -255,6 +297,11 @@ const QList<QUmlProperty *> QUmlArtifact::ownedAttributes() const return _ownedAttributes; } +/*! + Adds \a ownedAttribute to ownedAttributes. + + \sa ownedAttributes(), removeOwnedAttribute() + */ void QUmlArtifact::addOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end @@ -271,6 +318,11 @@ void QUmlArtifact::addOwnedAttribute(QUmlProperty *ownedAttribute) } } +/*! + Removes \a ownedAttribute from ownedAttributes. + + \sa ownedAttributes(), addOwnedAttribute() + */ void QUmlArtifact::removeOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end @@ -288,6 +340,10 @@ void QUmlArtifact::removeOwnedAttribute(QUmlProperty *ownedAttribute) /*! The Operations defined for the Artifact. The association is a specialization of the ownedMember association. + + \sa addOwnedOperation(), removeOwnedOperation() + + \b {Subsetted property(ies):} QUmlClassifier::features(), QUmlNamespace::ownedMembers(). */ const QList<QUmlOperation *> QUmlArtifact::ownedOperations() const { @@ -296,6 +352,11 @@ const QList<QUmlOperation *> QUmlArtifact::ownedOperations() const return _ownedOperations; } +/*! + Adds \a ownedOperation to ownedOperations. + + \sa ownedOperations(), removeOwnedOperation() + */ void QUmlArtifact::addOwnedOperation(QUmlOperation *ownedOperation) { // This is a read-write association end @@ -312,6 +373,11 @@ void QUmlArtifact::addOwnedOperation(QUmlOperation *ownedOperation) } } +/*! + Removes \a ownedOperation from ownedOperations. + + \sa ownedOperations(), addOwnedOperation() + */ void QUmlArtifact::removeOwnedOperation(QUmlOperation *ownedOperation) { // This is a read-write association end diff --git a/src/uml/qumlartifact.h b/src/uml/qumlartifact.h index 50ff88b2..e7222fe1 100644 --- a/src/uml/qumlartifact.h +++ b/src/uml/qumlartifact.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlDeployedArtifact> #include <QtUml/QUmlClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -91,7 +89,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlArtifact) *) -QT_END_HEADER - #endif // QUMLARTIFACT_H diff --git a/src/uml/qumlassociation.cpp b/src/uml/qumlassociation.cpp index 333197fa..20208070 100644 --- a/src/uml/qumlassociation.cpp +++ b/src/uml/qumlassociation.cpp @@ -78,6 +78,10 @@ QT_BEGIN_NAMESPACE \brief An association describes a set of tuples whose values refer to typed instances. An instance of an association is called a link.A link is a tuple with one value for each end of the association, where each value is an instance of the type of the end.An association describes a set of tuples whose values refer to typed instances. An instance of an association is called a link. A link is a tuple with one value for each end of the association, where each value is an instance of the type of the end. */ + +/*! + Creates a new QUmlAssociation. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlAssociation::QUmlAssociation(bool createQModelingObject) : _isDerived(false) { @@ -85,6 +89,9 @@ QUmlAssociation::QUmlAssociation(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlAssociationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlAssociation. +*/ QModelingElement *QUmlAssociation::clone() const { QUmlAssociation *c = new QUmlAssociation; @@ -145,6 +152,10 @@ QModelingElement *QUmlAssociation::clone() const /*! References the classifiers that are used as types of the ends of the association. + + \b {This is a read-only derived property.} + + \b {Subsetted property(ies):} QUmlRelationship::relatedElements(). */ const QList<QUmlType *> QUmlAssociation::endTypes() const { @@ -155,6 +166,11 @@ const QList<QUmlType *> QUmlAssociation::endTypes() const return QList<QUmlType *>(); } +/*! + Adds \a endType to endTypes. + + \sa endTypes(), removeEndType() + */ void QUmlAssociation::addEndType(QUmlType *endType) { // This is a read-only derived association end @@ -170,6 +186,11 @@ void QUmlAssociation::addEndType(QUmlType *endType) } } +/*! + Removes \a endType from endTypes. + + \sa endTypes(), addEndType() + */ void QUmlAssociation::removeEndType(QUmlType *endType) { // This is a read-only derived association end @@ -195,6 +216,9 @@ bool QUmlAssociation::isDerived() const return _isDerived; } +/*! + Adjusts isDerived to \a isDerived. + */ void QUmlAssociation::setDerived(bool isDerived) { // This is a read-write property @@ -207,6 +231,12 @@ void QUmlAssociation::setDerived(bool isDerived) /*! Each end represents participation of instances of the classifier connected to the end in links of the association. + + \sa addMemberEnd(), removeMemberEnd() + + \b {Subsetted property(ies):} QUmlNamespace::members(). + + \b {Opposite property(ies):} QUmlProperty::association(). */ const QList<QUmlProperty *> QUmlAssociation::memberEnds() const { @@ -215,6 +245,11 @@ const QList<QUmlProperty *> QUmlAssociation::memberEnds() const return _memberEnds; } +/*! + Adds \a memberEnd to memberEnds. + + \sa memberEnds(), removeMemberEnd() + */ void QUmlAssociation::addMemberEnd(QUmlProperty *memberEnd) { // This is a read-write association end @@ -234,6 +269,11 @@ void QUmlAssociation::addMemberEnd(QUmlProperty *memberEnd) } } +/*! + Removes \a memberEnd from memberEnds. + + \sa memberEnds(), addMemberEnd() + */ void QUmlAssociation::removeMemberEnd(QUmlProperty *memberEnd) { // This is a read-write association end @@ -253,6 +293,10 @@ void QUmlAssociation::removeMemberEnd(QUmlProperty *memberEnd) /*! The navigable ends that are owned by the association itself. + + \sa addNavigableOwnedEnd(), removeNavigableOwnedEnd() + + \b {Subsetted property(ies):} QUmlAssociation::ownedEnds(). */ const QSet<QUmlProperty *> QUmlAssociation::navigableOwnedEnds() const { @@ -261,6 +305,11 @@ const QSet<QUmlProperty *> QUmlAssociation::navigableOwnedEnds() const return _navigableOwnedEnds; } +/*! + Adds \a navigableOwnedEnd to navigableOwnedEnds. + + \sa navigableOwnedEnds(), removeNavigableOwnedEnd() + */ void QUmlAssociation::addNavigableOwnedEnd(QUmlProperty *navigableOwnedEnd) { // This is a read-write association end @@ -275,6 +324,11 @@ void QUmlAssociation::addNavigableOwnedEnd(QUmlProperty *navigableOwnedEnd) } } +/*! + Removes \a navigableOwnedEnd from navigableOwnedEnds. + + \sa navigableOwnedEnds(), addNavigableOwnedEnd() + */ void QUmlAssociation::removeNavigableOwnedEnd(QUmlProperty *navigableOwnedEnd) { // This is a read-write association end @@ -289,6 +343,12 @@ void QUmlAssociation::removeNavigableOwnedEnd(QUmlProperty *navigableOwnedEnd) /*! The ends that are owned by the association itself. + + \sa addOwnedEnd(), removeOwnedEnd() + + \b {Subsetted property(ies):} QUmlAssociation::memberEnds(), QUmlClassifier::features(), QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlProperty::owningAssociation(). */ const QList<QUmlProperty *> QUmlAssociation::ownedEnds() const { @@ -297,6 +357,11 @@ const QList<QUmlProperty *> QUmlAssociation::ownedEnds() const return _ownedEnds; } +/*! + Adds \a ownedEnd to ownedEnds. + + \sa ownedEnds(), removeOwnedEnd() + */ void QUmlAssociation::addOwnedEnd(QUmlProperty *ownedEnd) { // This is a read-write association end @@ -319,6 +384,11 @@ void QUmlAssociation::addOwnedEnd(QUmlProperty *ownedEnd) } } +/*! + Removes \a ownedEnd from ownedEnds. + + \sa ownedEnds(), addOwnedEnd() + */ void QUmlAssociation::removeOwnedEnd(QUmlProperty *ownedEnd) { // This is a read-write association end diff --git a/src/uml/qumlassociation.h b/src/uml/qumlassociation.h index 4bf94527..ba226142 100644 --- a/src/uml/qumlassociation.h +++ b/src/uml/qumlassociation.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlClassifier> #include <QtUml/QUmlRelationship> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -89,7 +87,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlAssociation) *) -QT_END_HEADER - #endif // QUMLASSOCIATION_H diff --git a/src/uml/qumlassociationclass.cpp b/src/uml/qumlassociationclass.cpp index b1db0d70..333a8f7c 100644 --- a/src/uml/qumlassociationclass.cpp +++ b/src/uml/qumlassociationclass.cpp @@ -87,6 +87,10 @@ QT_BEGIN_NAMESPACE \brief A model element that has both association and class properties. An AssociationClass can be seen as an association that also has class properties, or as a class that also has association properties. It not only connects a set of classifiers but also defines a set of features that belong to the relationship itself and not to any of the classifiers. */ + +/*! + Creates a new QUmlAssociationClass. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlAssociationClass::QUmlAssociationClass(bool createQModelingObject) : QUmlClass(false), QUmlAssociation(false) @@ -95,6 +99,9 @@ QUmlAssociationClass::QUmlAssociationClass(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlAssociationClassObject(this)); } +/*! + Returns a deep-copied clone of the QUmlAssociationClass. +*/ QModelingElement *QUmlAssociationClass::clone() const { QUmlAssociationClass *c = new QUmlAssociationClass; diff --git a/src/uml/qumlassociationclass.h b/src/uml/qumlassociationclass.h index 94e52510..b72aacf8 100644 --- a/src/uml/qumlassociationclass.h +++ b/src/uml/qumlassociationclass.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlClass> #include <QtUml/QUmlAssociation> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -67,7 +65,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlAssociationClass) *) -QT_END_HEADER - #endif // QUMLASSOCIATIONCLASS_H diff --git a/src/uml/qumlbehavior.cpp b/src/uml/qumlbehavior.cpp index d9e2f822..0a70e029 100644 --- a/src/uml/qumlbehavior.cpp +++ b/src/uml/qumlbehavior.cpp @@ -87,7 +87,13 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief Behavior is a specification of how its context classifier changes state over time. This specification may be either a definition of possible behavior execution or emergent behavior, or a selective illustration of an interesting subset of possible executions. The latter form is typically used for capturing examples, such as a trace of a particular execution.A behavior owns zero or more parameter sets. + + \b {QUmlBehavior is an abstract class.} */ + +/*! + Creates a new QUmlBehavior. +*/ QUmlBehavior::QUmlBehavior() : QUmlClass(false), _isReentrant(true), @@ -95,6 +101,9 @@ QUmlBehavior::QUmlBehavior() : { } +/*! + Returns a deep-copied clone of the QUmlBehavior. +*/ QModelingElement *QUmlBehavior::clone() const { QUmlBehavior *c = new QUmlBehavior; @@ -178,6 +187,10 @@ QModelingElement *QUmlBehavior::clone() const /*! The classifier that is the context for the execution of the behavior. If the behavior is owned by a BehavioredClassifier, that classifier is the context. Otherwise, the context is the first BehavioredClassifier reached by following the chain of owner relationships. For example, following this algorithm, the context of an entry action in a state machine is the classifier that owns the state machine. The features of the context classifier as well as the elements visible to the context classifier are visible to the behavior. + + \b {This is a read-only derived property.} + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinitionContexts(). */ QUmlBehavioredClassifier *QUmlBehavior::context() const { @@ -188,6 +201,9 @@ QUmlBehavioredClassifier *QUmlBehavior::context() const return 0; } +/*! + Adjusts context to \a context. + */ void QUmlBehavior::setContext(QUmlBehavioredClassifier *context) { // This is a read-only derived association end @@ -218,6 +234,9 @@ bool QUmlBehavior::isReentrant() const return _isReentrant; } +/*! + Adjusts isReentrant to \a isReentrant. + */ void QUmlBehavior::setReentrant(bool isReentrant) { // This is a read-write property @@ -230,6 +249,10 @@ void QUmlBehavior::setReentrant(bool isReentrant) /*! References a list of parameters to the behavior which describes the order and type of arguments that can be given when the behavior is invoked and of the values which will be returned when the behavior completes its execution. + + \sa addOwnedParameter(), removeOwnedParameter() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QList<QUmlParameter *> QUmlBehavior::ownedParameters() const { @@ -238,6 +261,11 @@ const QList<QUmlParameter *> QUmlBehavior::ownedParameters() const return _ownedParameters; } +/*! + Adds \a ownedParameter to ownedParameters. + + \sa ownedParameters(), removeOwnedParameter() + */ void QUmlBehavior::addOwnedParameter(QUmlParameter *ownedParameter) { // This is a read-write association end @@ -253,6 +281,11 @@ void QUmlBehavior::addOwnedParameter(QUmlParameter *ownedParameter) } } +/*! + Removes \a ownedParameter from ownedParameters. + + \sa ownedParameters(), addOwnedParameter() + */ void QUmlBehavior::removeOwnedParameter(QUmlParameter *ownedParameter) { // This is a read-write association end @@ -269,6 +302,10 @@ void QUmlBehavior::removeOwnedParameter(QUmlParameter *ownedParameter) /*! The ParameterSets owned by this Behavior. + + \sa addOwnedParameterSet(), removeOwnedParameterSet() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QSet<QUmlParameterSet *> QUmlBehavior::ownedParameterSets() const { @@ -277,6 +314,11 @@ const QSet<QUmlParameterSet *> QUmlBehavior::ownedParameterSets() const return _ownedParameterSets; } +/*! + Adds \a ownedParameterSet to ownedParameterSets. + + \sa ownedParameterSets(), removeOwnedParameterSet() + */ void QUmlBehavior::addOwnedParameterSet(QUmlParameterSet *ownedParameterSet) { // This is a read-write association end @@ -292,6 +334,11 @@ void QUmlBehavior::addOwnedParameterSet(QUmlParameterSet *ownedParameterSet) } } +/*! + Removes \a ownedParameterSet from ownedParameterSets. + + \sa ownedParameterSets(), addOwnedParameterSet() + */ void QUmlBehavior::removeOwnedParameterSet(QUmlParameterSet *ownedParameterSet) { // This is a read-write association end @@ -308,6 +355,10 @@ void QUmlBehavior::removeOwnedParameterSet(QUmlParameterSet *ownedParameterSet) /*! An optional set of Constraints specifying what is fulfilled after the execution of the behavior is completed, if its precondition was fulfilled before its invocation. + + \sa addPostcondition(), removePostcondition() + + \b {Subsetted property(ies):} QUmlNamespace::ownedRules(). */ const QSet<QUmlConstraint *> QUmlBehavior::postconditions() const { @@ -316,6 +367,11 @@ const QSet<QUmlConstraint *> QUmlBehavior::postconditions() const return _postconditions; } +/*! + Adds \a postcondition to postconditions. + + \sa postconditions(), removePostcondition() + */ void QUmlBehavior::addPostcondition(QUmlConstraint *postcondition) { // This is a read-write association end @@ -331,6 +387,11 @@ void QUmlBehavior::addPostcondition(QUmlConstraint *postcondition) } } +/*! + Removes \a postcondition from postconditions. + + \sa postconditions(), addPostcondition() + */ void QUmlBehavior::removePostcondition(QUmlConstraint *postcondition) { // This is a read-write association end @@ -347,6 +408,10 @@ void QUmlBehavior::removePostcondition(QUmlConstraint *postcondition) /*! An optional set of Constraints specifying what must be fulfilled when the behavior is invoked. + + \sa addPrecondition(), removePrecondition() + + \b {Subsetted property(ies):} QUmlNamespace::ownedRules(). */ const QSet<QUmlConstraint *> QUmlBehavior::preconditions() const { @@ -355,6 +420,11 @@ const QSet<QUmlConstraint *> QUmlBehavior::preconditions() const return _preconditions; } +/*! + Adds \a precondition to preconditions. + + \sa preconditions(), removePrecondition() + */ void QUmlBehavior::addPrecondition(QUmlConstraint *precondition) { // This is a read-write association end @@ -370,6 +440,11 @@ void QUmlBehavior::addPrecondition(QUmlConstraint *precondition) } } +/*! + Removes \a precondition from preconditions. + + \sa preconditions(), addPrecondition() + */ void QUmlBehavior::removePrecondition(QUmlConstraint *precondition) { // This is a read-write association end @@ -386,6 +461,10 @@ void QUmlBehavior::removePrecondition(QUmlConstraint *precondition) /*! References a behavior that this behavior redefines. A subtype of Behavior may redefine any other subtype of Behavior. If the behavior implements a behavioral feature, it replaces the redefined behavior. If the behavior is a classifier behavior, it extends the redefined behavior. + + \sa addRedefinedBehavior(), removeRedefinedBehavior() + + \b {Subsetted property(ies):} QUmlClassifier::redefinedClassifiers(). */ const QSet<QUmlBehavior *> QUmlBehavior::redefinedBehaviors() const { @@ -394,6 +473,11 @@ const QSet<QUmlBehavior *> QUmlBehavior::redefinedBehaviors() const return _redefinedBehaviors; } +/*! + Adds \a redefinedBehavior to redefinedBehaviors. + + \sa redefinedBehaviors(), removeRedefinedBehavior() + */ void QUmlBehavior::addRedefinedBehavior(QUmlBehavior *redefinedBehavior) { // This is a read-write association end @@ -408,6 +492,11 @@ void QUmlBehavior::addRedefinedBehavior(QUmlBehavior *redefinedBehavior) } } +/*! + Removes \a redefinedBehavior from redefinedBehaviors. + + \sa redefinedBehaviors(), addRedefinedBehavior() + */ void QUmlBehavior::removeRedefinedBehavior(QUmlBehavior *redefinedBehavior) { // This is a read-write association end @@ -422,6 +511,8 @@ void QUmlBehavior::removeRedefinedBehavior(QUmlBehavior *redefinedBehavior) /*! Designates a behavioral feature that the behavior implements. The behavioral feature must be owned by the classifier that owns the behavior or be inherited by it. The parameters of the behavioral feature and the implementing behavior must match. A behavior does not need to have a specification, in which case it either is the classifer behavior of a BehavioredClassifier or it can only be invoked by another behavior of the classifier. + + \b {Opposite property(ies):} QUmlBehavioralFeature::methods(). */ QUmlBehavioralFeature *QUmlBehavior::specification() const { @@ -430,6 +521,9 @@ QUmlBehavioralFeature *QUmlBehavior::specification() const return _specification; } +/*! + Adjusts specification to \a specification. + */ void QUmlBehavior::setSpecification(QUmlBehavioralFeature *specification) { // This is a read-write association end diff --git a/src/uml/qumlbehavior.h b/src/uml/qumlbehavior.h index 52af5cb0..7133a2ee 100644 --- a/src/uml/qumlbehavior.h +++ b/src/uml/qumlbehavior.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlClass> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -101,7 +99,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlBehavior) *) -QT_END_HEADER - #endif // QUMLBEHAVIOR_H diff --git a/src/uml/qumlbehavioralfeature.cpp b/src/uml/qumlbehavioralfeature.cpp index e9c01328..41802ddb 100644 --- a/src/uml/qumlbehavioralfeature.cpp +++ b/src/uml/qumlbehavioralfeature.cpp @@ -65,13 +65,22 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A behavioral feature is a feature of a classifier that specifies an aspect of the behavior of its instances.A behavioral feature is implemented (realized) by a behavior. A behavioral feature specifies that a classifier will respond to a designated request by invoking its implementing method.A behavioral feature owns zero or more parameter sets. + + \b {QUmlBehavioralFeature is an abstract class.} */ + +/*! + Creates a new QUmlBehavioralFeature. +*/ QUmlBehavioralFeature::QUmlBehavioralFeature() : _concurrency(QtUml::CallConcurrencyKindSequential), _isAbstract(false) { } +/*! + Returns a deep-copied clone of the QUmlBehavioralFeature. +*/ QModelingElement *QUmlBehavioralFeature::clone() const { QUmlBehavioralFeature *c = new QUmlBehavioralFeature; @@ -116,6 +125,9 @@ QtUml::CallConcurrencyKind QUmlBehavioralFeature::concurrency() const return _concurrency; } +/*! + Adjusts concurrency to \a concurrency. + */ void QUmlBehavioralFeature::setConcurrency(QtUml::CallConcurrencyKind concurrency) { // This is a read-write property @@ -136,6 +148,9 @@ bool QUmlBehavioralFeature::isAbstract() const return _isAbstract; } +/*! + Adjusts isAbstract to \a isAbstract. + */ void QUmlBehavioralFeature::setAbstract(bool isAbstract) { // This is a read-write property @@ -148,6 +163,10 @@ void QUmlBehavioralFeature::setAbstract(bool isAbstract) /*! A behavioral description that implements the behavioral feature. There may be at most one behavior for a particular pairing of a classifier (as owner of the behavior) and a behavioral feature (as specification of the behavior). + + \sa addMethod(), removeMethod() + + \b {Opposite property(ies):} QUmlBehavior::specification(). */ const QSet<QUmlBehavior *> QUmlBehavioralFeature::methods() const { @@ -156,6 +175,11 @@ const QSet<QUmlBehavior *> QUmlBehavioralFeature::methods() const return _methods; } +/*! + Adds \a method to methods. + + \sa methods(), removeMethod() + */ void QUmlBehavioralFeature::addMethod(QUmlBehavior *method) { // This is a read-write association end @@ -172,6 +196,11 @@ void QUmlBehavioralFeature::addMethod(QUmlBehavior *method) } } +/*! + Removes \a method from methods. + + \sa methods(), addMethod() + */ void QUmlBehavioralFeature::removeMethod(QUmlBehavior *method) { // This is a read-write association end @@ -188,6 +217,10 @@ void QUmlBehavioralFeature::removeMethod(QUmlBehavior *method) /*! Specifies the ordered set of formal parameters of this BehavioralFeature. + + \sa addOwnedParameter(), removeOwnedParameter() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QList<QUmlParameter *> QUmlBehavioralFeature::ownedParameters() const { @@ -196,6 +229,11 @@ const QList<QUmlParameter *> QUmlBehavioralFeature::ownedParameters() const return _ownedParameters; } +/*! + Adds \a ownedParameter to ownedParameters. + + \sa ownedParameters(), removeOwnedParameter() + */ void QUmlBehavioralFeature::addOwnedParameter(QUmlParameter *ownedParameter) { // This is a read-write association end @@ -211,6 +249,11 @@ void QUmlBehavioralFeature::addOwnedParameter(QUmlParameter *ownedParameter) } } +/*! + Removes \a ownedParameter from ownedParameters. + + \sa ownedParameters(), addOwnedParameter() + */ void QUmlBehavioralFeature::removeOwnedParameter(QUmlParameter *ownedParameter) { // This is a read-write association end @@ -227,6 +270,10 @@ void QUmlBehavioralFeature::removeOwnedParameter(QUmlParameter *ownedParameter) /*! The ParameterSets owned by this BehavioralFeature. + + \sa addOwnedParameterSet(), removeOwnedParameterSet() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QSet<QUmlParameterSet *> QUmlBehavioralFeature::ownedParameterSets() const { @@ -235,6 +282,11 @@ const QSet<QUmlParameterSet *> QUmlBehavioralFeature::ownedParameterSets() const return _ownedParameterSets; } +/*! + Adds \a ownedParameterSet to ownedParameterSets. + + \sa ownedParameterSets(), removeOwnedParameterSet() + */ void QUmlBehavioralFeature::addOwnedParameterSet(QUmlParameterSet *ownedParameterSet) { // This is a read-write association end @@ -250,6 +302,11 @@ void QUmlBehavioralFeature::addOwnedParameterSet(QUmlParameterSet *ownedParamete } } +/*! + Removes \a ownedParameterSet from ownedParameterSets. + + \sa ownedParameterSets(), addOwnedParameterSet() + */ void QUmlBehavioralFeature::removeOwnedParameterSet(QUmlParameterSet *ownedParameterSet) { // This is a read-write association end @@ -266,6 +323,8 @@ void QUmlBehavioralFeature::removeOwnedParameterSet(QUmlParameterSet *ownedParam /*! References the Types representing exceptions that may be raised during an invocation of this feature. + + \sa addRaisedException(), removeRaisedException() */ const QSet<QUmlType *> QUmlBehavioralFeature::raisedExceptions() const { @@ -274,6 +333,11 @@ const QSet<QUmlType *> QUmlBehavioralFeature::raisedExceptions() const return _raisedExceptions; } +/*! + Adds \a raisedException to raisedExceptions. + + \sa raisedExceptions(), removeRaisedException() + */ void QUmlBehavioralFeature::addRaisedException(QUmlType *raisedException) { // This is a read-write association end @@ -285,6 +349,11 @@ void QUmlBehavioralFeature::addRaisedException(QUmlType *raisedException) } } +/*! + Removes \a raisedException from raisedExceptions. + + \sa raisedExceptions(), addRaisedException() + */ void QUmlBehavioralFeature::removeRaisedException(QUmlType *raisedException) { // This is a read-write association end diff --git a/src/uml/qumlbehavioralfeature.h b/src/uml/qumlbehavioralfeature.h index bd79baea..ca53bd3b 100644 --- a/src/uml/qumlbehavioralfeature.h +++ b/src/uml/qumlbehavioralfeature.h @@ -48,8 +48,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -101,7 +99,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlBehavioralFeature) *) -QT_END_HEADER - #endif // QUMLBEHAVIORALFEATURE_H diff --git a/src/uml/qumlbehavioredclassifier.cpp b/src/uml/qumlbehavioredclassifier.cpp index 69040457..409a53f0 100644 --- a/src/uml/qumlbehavioredclassifier.cpp +++ b/src/uml/qumlbehavioredclassifier.cpp @@ -77,12 +77,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A behaviored classifier may have an interface realization.A classifier can have behavior specifications defined in its namespace. One of these may specify the behavior of the classifier itself. + + \b {QUmlBehavioredClassifier is an abstract class.} */ + +/*! + Creates a new QUmlBehavioredClassifier. +*/ QUmlBehavioredClassifier::QUmlBehavioredClassifier() : _classifierBehavior(0) { } +/*! + Returns a deep-copied clone of the QUmlBehavioredClassifier. +*/ QModelingElement *QUmlBehavioredClassifier::clone() const { QUmlBehavioredClassifier *c = new QUmlBehavioredClassifier; @@ -142,6 +151,8 @@ QModelingElement *QUmlBehavioredClassifier::clone() const /*! A behavior specification that specifies the behavior of the classifier itself. + + \b {Subsetted property(ies):} QUmlBehavioredClassifier::ownedBehaviors(). */ QUmlBehavior *QUmlBehavioredClassifier::classifierBehavior() const { @@ -150,6 +161,9 @@ QUmlBehavior *QUmlBehavioredClassifier::classifierBehavior() const return _classifierBehavior; } +/*! + Adjusts classifierBehavior to \a classifierBehavior. + */ void QUmlBehavioredClassifier::setClassifierBehavior(QUmlBehavior *classifierBehavior) { // This is a read-write association end @@ -171,6 +185,12 @@ void QUmlBehavioredClassifier::setClassifierBehavior(QUmlBehavior *classifierBeh /*! The set of InterfaceRealizations owned by the BehavioredClassifier. Interface realizations reference the Interfaces of which the BehavioredClassifier is an implementation. + + \sa addInterfaceRealization(), removeInterfaceRealization() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(), QUmlNamedElement::clientDependencies(). + + \b {Opposite property(ies):} QUmlInterfaceRealization::implementingClassifier(). */ const QSet<QUmlInterfaceRealization *> QUmlBehavioredClassifier::interfaceRealizations() const { @@ -179,6 +199,11 @@ const QSet<QUmlInterfaceRealization *> QUmlBehavioredClassifier::interfaceRealiz return _interfaceRealizations; } +/*! + Adds \a interfaceRealization to interfaceRealizations. + + \sa interfaceRealizations(), removeInterfaceRealization() + */ void QUmlBehavioredClassifier::addInterfaceRealization(QUmlInterfaceRealization *interfaceRealization) { // This is a read-write association end @@ -200,6 +225,11 @@ void QUmlBehavioredClassifier::addInterfaceRealization(QUmlInterfaceRealization } } +/*! + Removes \a interfaceRealization from interfaceRealizations. + + \sa interfaceRealizations(), addInterfaceRealization() + */ void QUmlBehavioredClassifier::removeInterfaceRealization(QUmlInterfaceRealization *interfaceRealization) { // This is a read-write association end @@ -222,6 +252,10 @@ void QUmlBehavioredClassifier::removeInterfaceRealization(QUmlInterfaceRealizati /*! References behavior specifications owned by a classifier. + + \sa addOwnedBehavior(), removeOwnedBehavior() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QSet<QUmlBehavior *> QUmlBehavioredClassifier::ownedBehaviors() const { @@ -230,6 +264,11 @@ const QSet<QUmlBehavior *> QUmlBehavioredClassifier::ownedBehaviors() const return _ownedBehaviors; } +/*! + Adds \a ownedBehavior to ownedBehaviors. + + \sa ownedBehaviors(), removeOwnedBehavior() + */ void QUmlBehavioredClassifier::addOwnedBehavior(QUmlBehavior *ownedBehavior) { // This is a read-write association end @@ -245,6 +284,11 @@ void QUmlBehavioredClassifier::addOwnedBehavior(QUmlBehavior *ownedBehavior) } } +/*! + Removes \a ownedBehavior from ownedBehaviors. + + \sa ownedBehaviors(), addOwnedBehavior() + */ void QUmlBehavioredClassifier::removeOwnedBehavior(QUmlBehavior *ownedBehavior) { // This is a read-write association end diff --git a/src/uml/qumlbehavioredclassifier.h b/src/uml/qumlbehavioredclassifier.h index c32dacb0..7eede10a 100644 --- a/src/uml/qumlbehavioredclassifier.h +++ b/src/uml/qumlbehavioredclassifier.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlBehavioredClassifier) *) -QT_END_HEADER - #endif // QUMLBEHAVIOREDCLASSIFIER_H diff --git a/src/uml/qumlbehaviorexecutionspecification.cpp b/src/uml/qumlbehaviorexecutionspecification.cpp index dcf13c40..282c3745 100644 --- a/src/uml/qumlbehaviorexecutionspecification.cpp +++ b/src/uml/qumlbehaviorexecutionspecification.cpp @@ -65,6 +65,10 @@ QT_BEGIN_NAMESPACE \brief A behavior execution specification is a kind of execution specification representing the execution of a behavior. */ + +/*! + Creates a new QUmlBehaviorExecutionSpecification. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlBehaviorExecutionSpecification::QUmlBehaviorExecutionSpecification(bool createQModelingObject) : _behavior(0) { @@ -72,6 +76,9 @@ QUmlBehaviorExecutionSpecification::QUmlBehaviorExecutionSpecification(bool crea _qModelingObject = qobject_cast<QModelingObject *>(new QUmlBehaviorExecutionSpecificationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlBehaviorExecutionSpecification. +*/ QModelingElement *QUmlBehaviorExecutionSpecification::clone() const { QUmlBehaviorExecutionSpecification *c = new QUmlBehaviorExecutionSpecification; @@ -112,6 +119,9 @@ QUmlBehavior *QUmlBehaviorExecutionSpecification::behavior() const return _behavior; } +/*! + Adjusts behavior to \a behavior. + */ void QUmlBehaviorExecutionSpecification::setBehavior(QUmlBehavior *behavior) { // This is a read-write association end diff --git a/src/uml/qumlbehaviorexecutionspecification.h b/src/uml/qumlbehaviorexecutionspecification.h index 6b6423b2..56fc1347 100644 --- a/src/uml/qumlbehaviorexecutionspecification.h +++ b/src/uml/qumlbehaviorexecutionspecification.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlExecutionSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlBehaviorExecutionSpecification) *) -QT_END_HEADER - #endif // QUMLBEHAVIOREXECUTIONSPECIFICATION_H diff --git a/src/uml/qumlbroadcastsignalaction.cpp b/src/uml/qumlbroadcastsignalaction.cpp index 696dc3e9..375bcbe4 100644 --- a/src/uml/qumlbroadcastsignalaction.cpp +++ b/src/uml/qumlbroadcastsignalaction.cpp @@ -74,6 +74,10 @@ QT_BEGIN_NAMESPACE \brief A broadcast signal action is an action that transmits a signal instance to all the potential target objects in the system, which may cause the firing of a state machine transitions or the execution of associated activities of a target object. The argument values are available to the execution of associated behaviors. The requestor continues execution immediately after the signals are sent out. It does not wait for receipt. Any reply messages are ignored and are not transmitted to the requestor. */ + +/*! + Creates a new QUmlBroadcastSignalAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlBroadcastSignalAction::QUmlBroadcastSignalAction(bool createQModelingObject) : _signal(0) { @@ -81,6 +85,9 @@ QUmlBroadcastSignalAction::QUmlBroadcastSignalAction(bool createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlBroadcastSignalActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlBroadcastSignalAction. +*/ QModelingElement *QUmlBroadcastSignalAction::clone() const { QUmlBroadcastSignalAction *c = new QUmlBroadcastSignalAction; @@ -135,6 +142,9 @@ QUmlSignal *QUmlBroadcastSignalAction::signal() const return _signal; } +/*! + Adjusts signal to \a signal. + */ void QUmlBroadcastSignalAction::setSignal(QUmlSignal *signal) { // This is a read-write association end diff --git a/src/uml/qumlbroadcastsignalaction.h b/src/uml/qumlbroadcastsignalaction.h index f9f20551..1b4dc623 100644 --- a/src/uml/qumlbroadcastsignalaction.h +++ b/src/uml/qumlbroadcastsignalaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInvocationAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlBroadcastSignalAction) *) -QT_END_HEADER - #endif // QUMLBROADCASTSIGNALACTION_H diff --git a/src/uml/qumlcallaction.cpp b/src/uml/qumlcallaction.cpp index 93461611..38ed2c22 100644 --- a/src/uml/qumlcallaction.cpp +++ b/src/uml/qumlcallaction.cpp @@ -70,12 +70,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief CallAction is an abstract class for actions that invoke behavior and receive return values. + + \b {QUmlCallAction is an abstract class.} */ + +/*! + Creates a new QUmlCallAction. +*/ QUmlCallAction::QUmlCallAction() : _isSynchronous(true) { } +/*! + Returns a deep-copied clone of the QUmlCallAction. +*/ QModelingElement *QUmlCallAction::clone() const { QUmlCallAction *c = new QUmlCallAction; @@ -131,6 +140,9 @@ bool QUmlCallAction::isSynchronous() const return _isSynchronous; } +/*! + Adjusts isSynchronous to \a isSynchronous. + */ void QUmlCallAction::setSynchronous(bool isSynchronous) { // This is a read-write property @@ -143,6 +155,10 @@ void QUmlCallAction::setSynchronous(bool isSynchronous) /*! A list of output pins where the results of performing the invocation are placed. + + \sa addResult(), removeResult() + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ const QList<QUmlOutputPin *> QUmlCallAction::results() const { @@ -151,6 +167,11 @@ const QList<QUmlOutputPin *> QUmlCallAction::results() const return _results; } +/*! + Adds \a result to results. + + \sa results(), removeResult() + */ void QUmlCallAction::addResult(QUmlOutputPin *result) { // This is a read-write association end @@ -166,6 +187,11 @@ void QUmlCallAction::addResult(QUmlOutputPin *result) } } +/*! + Removes \a result from results. + + \sa results(), addResult() + */ void QUmlCallAction::removeResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlcallaction.h b/src/uml/qumlcallaction.h index bba29b8b..8307b490 100644 --- a/src/uml/qumlcallaction.h +++ b/src/uml/qumlcallaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInvocationAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCallAction) *) -QT_END_HEADER - #endif // QUMLCALLACTION_H diff --git a/src/uml/qumlcallbehavioraction.cpp b/src/uml/qumlcallbehavioraction.cpp index b6b9d0bb..264856d4 100644 --- a/src/uml/qumlcallbehavioraction.cpp +++ b/src/uml/qumlcallbehavioraction.cpp @@ -74,6 +74,10 @@ QT_BEGIN_NAMESPACE \brief A call behavior action is a call action that invokes a behavior directly rather than invoking a behavioral feature that, in turn, results in the invocation of that behavior. The argument values of the action are available to the execution of the invoked behavior. For synchronous calls the execution of the call behavior action waits until the execution of the invoked behavior completes and a result is returned on its output pin. The action completes immediately without a result, if the call is asynchronous. In particular, the invoked behavior may be an activity. */ + +/*! + Creates a new QUmlCallBehaviorAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlCallBehaviorAction::QUmlCallBehaviorAction(bool createQModelingObject) : _behavior(0) { @@ -81,6 +85,9 @@ QUmlCallBehaviorAction::QUmlCallBehaviorAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCallBehaviorActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlCallBehaviorAction. +*/ QModelingElement *QUmlCallBehaviorAction::clone() const { QUmlCallBehaviorAction *c = new QUmlCallBehaviorAction; @@ -138,6 +145,9 @@ QUmlBehavior *QUmlCallBehaviorAction::behavior() const return _behavior; } +/*! + Adjusts behavior to \a behavior. + */ void QUmlCallBehaviorAction::setBehavior(QUmlBehavior *behavior) { // This is a read-write association end diff --git a/src/uml/qumlcallbehavioraction.h b/src/uml/qumlcallbehavioraction.h index 33c0548a..653cb615 100644 --- a/src/uml/qumlcallbehavioraction.h +++ b/src/uml/qumlcallbehavioraction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlCallAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCallBehaviorAction) *) -QT_END_HEADER - #endif // QUMLCALLBEHAVIORACTION_H diff --git a/src/uml/qumlcallevent.cpp b/src/uml/qumlcallevent.cpp index e83ed84e..b9758663 100644 --- a/src/uml/qumlcallevent.cpp +++ b/src/uml/qumlcallevent.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief A call event models the receipt by an object of a message invoking a call of an operation. */ + +/*! + Creates a new QUmlCallEvent. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlCallEvent::QUmlCallEvent(bool createQModelingObject) : _operation(0) { @@ -69,6 +73,9 @@ QUmlCallEvent::QUmlCallEvent(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCallEventObject(this)); } +/*! + Returns a deep-copied clone of the QUmlCallEvent. +*/ QModelingElement *QUmlCallEvent::clone() const { QUmlCallEvent *c = new QUmlCallEvent; @@ -101,6 +108,9 @@ QUmlOperation *QUmlCallEvent::operation() const return _operation; } +/*! + Adjusts operation to \a operation. + */ void QUmlCallEvent::setOperation(QUmlOperation *operation) { // This is a read-write association end diff --git a/src/uml/qumlcallevent.h b/src/uml/qumlcallevent.h index 0afa4cbc..256ad784 100644 --- a/src/uml/qumlcallevent.h +++ b/src/uml/qumlcallevent.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlMessageEvent> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCallEvent) *) -QT_END_HEADER - #endif // QUMLCALLEVENT_H diff --git a/src/uml/qumlcalloperationaction.cpp b/src/uml/qumlcalloperationaction.cpp index 84f5a7a5..82d1e6eb 100644 --- a/src/uml/qumlcalloperationaction.cpp +++ b/src/uml/qumlcalloperationaction.cpp @@ -74,6 +74,10 @@ QT_BEGIN_NAMESPACE \brief A call operation action is an action that transmits an operation call request to the target object, where it may cause the invocation of associated behavior. The argument values of the action are available to the execution of the invoked behavior. If the action is marked synchronous, the execution of the call operation action waits until the execution of the invoked behavior completes and a reply transmission is returned to the caller; otherwise execution of the action is complete when the invocation of the operation is established and the execution of the invoked operation proceeds concurrently with the execution of the calling behavior. Any values returned as part of the reply transmission are put on the result output pins of the call operation action. Upon receipt of the reply transmission, execution of the call operation action is complete. */ + +/*! + Creates a new QUmlCallOperationAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlCallOperationAction::QUmlCallOperationAction(bool createQModelingObject) : _operation(0), _target(0) @@ -82,6 +86,9 @@ QUmlCallOperationAction::QUmlCallOperationAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCallOperationActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlCallOperationAction. +*/ QModelingElement *QUmlCallOperationAction::clone() const { QUmlCallOperationAction *c = new QUmlCallOperationAction; @@ -141,6 +148,9 @@ QUmlOperation *QUmlCallOperationAction::operation() const return _operation; } +/*! + Adjusts operation to \a operation. + */ void QUmlCallOperationAction::setOperation(QUmlOperation *operation) { // This is a read-write association end @@ -154,6 +164,8 @@ void QUmlCallOperationAction::setOperation(QUmlOperation *operation) /*! The target object to which the request is sent. The classifier of the target object is used to dynamically determine a behavior to invoke. This object constitutes the context of the execution of the operation. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlCallOperationAction::target() const { @@ -162,6 +174,9 @@ QUmlInputPin *QUmlCallOperationAction::target() const return _target; } +/*! + Adjusts target to \a target. + */ void QUmlCallOperationAction::setTarget(QUmlInputPin *target) { // This is a read-write association end diff --git a/src/uml/qumlcalloperationaction.h b/src/uml/qumlcalloperationaction.h index acfcbea7..d551fb4f 100644 --- a/src/uml/qumlcalloperationaction.h +++ b/src/uml/qumlcalloperationaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlCallAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCallOperationAction) *) -QT_END_HEADER - #endif // QUMLCALLOPERATIONACTION_H diff --git a/src/uml/qumlcentralbuffernode.cpp b/src/uml/qumlcentralbuffernode.cpp index 282921b1..be6c351a 100644 --- a/src/uml/qumlcentralbuffernode.cpp +++ b/src/uml/qumlcentralbuffernode.cpp @@ -72,12 +72,19 @@ QT_BEGIN_NAMESPACE \brief A central buffer node is an object node for managing flows from multiple sources and destinations. */ + +/*! + Creates a new QUmlCentralBufferNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlCentralBufferNode::QUmlCentralBufferNode(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCentralBufferNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlCentralBufferNode. +*/ QModelingElement *QUmlCentralBufferNode::clone() const { QUmlCentralBufferNode *c = new QUmlCentralBufferNode; diff --git a/src/uml/qumlcentralbuffernode.h b/src/uml/qumlcentralbuffernode.h index 64b7e7b2..0c9d8bca 100644 --- a/src/uml/qumlcentralbuffernode.h +++ b/src/uml/qumlcentralbuffernode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlObjectNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCentralBufferNode) *) -QT_END_HEADER - #endif // QUMLCENTRALBUFFERNODE_H diff --git a/src/uml/qumlchangeevent.cpp b/src/uml/qumlchangeevent.cpp index cf76a3b4..d7b45e11 100644 --- a/src/uml/qumlchangeevent.cpp +++ b/src/uml/qumlchangeevent.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief A change event models a change in the system configuration that makes a condition true. */ + +/*! + Creates a new QUmlChangeEvent. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlChangeEvent::QUmlChangeEvent(bool createQModelingObject) : _changeExpression(0) { @@ -69,6 +73,9 @@ QUmlChangeEvent::QUmlChangeEvent(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlChangeEventObject(this)); } +/*! + Returns a deep-copied clone of the QUmlChangeEvent. +*/ QModelingElement *QUmlChangeEvent::clone() const { QUmlChangeEvent *c = new QUmlChangeEvent; @@ -93,6 +100,8 @@ QModelingElement *QUmlChangeEvent::clone() const /*! A Boolean-valued expression that will result in a change event whenever its value changes from false to true. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlChangeEvent::changeExpression() const { @@ -101,6 +110,9 @@ QUmlValueSpecification *QUmlChangeEvent::changeExpression() const return _changeExpression; } +/*! + Adjusts changeExpression to \a changeExpression. + */ void QUmlChangeEvent::setChangeExpression(QUmlValueSpecification *changeExpression) { // This is a read-write association end diff --git a/src/uml/qumlchangeevent.h b/src/uml/qumlchangeevent.h index 211ed866..5a43a252 100644 --- a/src/uml/qumlchangeevent.h +++ b/src/uml/qumlchangeevent.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlEvent> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlChangeEvent) *) -QT_END_HEADER - #endif // QUMLCHANGEEVENT_H diff --git a/src/uml/qumlclass.cpp b/src/uml/qumlclass.cpp index 77e02bee..a8fc1648 100644 --- a/src/uml/qumlclass.cpp +++ b/src/uml/qumlclass.cpp @@ -87,6 +87,10 @@ QT_BEGIN_NAMESPACE \brief A class may be designated as active (i.e., each of its instances having its own thread of control) or passive (i.e., each of its instances executing within the context of some other object). A class may also specify which signals the instances of this class handle.A class describes a set of objects that share the same specifications of features, constraints, and semantics.A class has the capability to have an internal structure and ports.Class has derived association that indicates how it may be extended through one or more stereotypes. Stereotype is the only kind of metaclass that cannot be extended by stereotypes. */ + +/*! + Creates a new QUmlClass. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlClass::QUmlClass(bool createQModelingObject) : _isAbstract(false), _isActive(false) @@ -95,6 +99,9 @@ QUmlClass::QUmlClass(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlClassObject(this)); } +/*! + Returns a deep-copied clone of the QUmlClass. +*/ QModelingElement *QUmlClass::clone() const { QUmlClass *c = new QUmlClass; @@ -165,6 +172,10 @@ QModelingElement *QUmlClass::clone() const /*! References the Extensions that specify additional properties of the metaclass. The property is derived from the extensions whose memberEnds are typed by the Class. + + \b {This is a read-only derived property.} + + \b {Opposite property(ies):} QUmlExtension::metaclass(). */ const QSet<QUmlExtension *> QUmlClass::extensions() const { @@ -175,6 +186,11 @@ const QSet<QUmlExtension *> QUmlClass::extensions() const return QSet<QUmlExtension *>(); } +/*! + Adds \a extension to extensions. + + \sa extensions(), removeExtension() + */ void QUmlClass::addExtension(QUmlExtension *extension) { // This is a read-only derived association end @@ -192,6 +208,11 @@ void QUmlClass::addExtension(QUmlExtension *extension) } } +/*! + Removes \a extension from extensions. + + \sa extensions(), addExtension() + */ void QUmlClass::removeExtension(QUmlExtension *extension) { // This is a read-only derived association end @@ -211,6 +232,8 @@ void QUmlClass::removeExtension(QUmlExtension *extension) /*! If true, the Classifier does not provide a complete declaration and can typically not be instantiated. An abstract classifier is intended to be used by other classifiers e.g. as the target of general metarelationships or generalization relationships.True when a class is abstract. + + \b {Redefined property(ies):} QUmlClassifier::isAbstract(). */ bool QUmlClass::isAbstract() const { @@ -219,6 +242,9 @@ bool QUmlClass::isAbstract() const return _isAbstract; } +/*! + Adjusts isAbstract to \a isAbstract. + */ void QUmlClass::setAbstract(bool isAbstract) { // This is a read-write property @@ -242,6 +268,9 @@ bool QUmlClass::isActive() const return _isActive; } +/*! + Adjusts isActive to \a isActive. + */ void QUmlClass::setActive(bool isActive) { // This is a read-write property @@ -254,6 +283,10 @@ void QUmlClass::setActive(bool isActive) /*! References all the Classifiers that are defined (nested) within the Class. + + \sa addNestedClassifier(), removeNestedClassifier() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QList<QUmlClassifier *> QUmlClass::nestedClassifiers() const { @@ -262,6 +295,11 @@ const QList<QUmlClassifier *> QUmlClass::nestedClassifiers() const return _nestedClassifiers; } +/*! + Adds \a nestedClassifier to nestedClassifiers. + + \sa nestedClassifiers(), removeNestedClassifier() + */ void QUmlClass::addNestedClassifier(QUmlClassifier *nestedClassifier) { // This is a read-write association end @@ -277,6 +315,11 @@ void QUmlClass::addNestedClassifier(QUmlClassifier *nestedClassifier) } } +/*! + Removes \a nestedClassifier from nestedClassifiers. + + \sa nestedClassifiers(), addNestedClassifier() + */ void QUmlClass::removeNestedClassifier(QUmlClassifier *nestedClassifier) { // This is a read-write association end @@ -293,6 +336,14 @@ void QUmlClass::removeNestedClassifier(QUmlClassifier *nestedClassifier) /*! The attributes (i.e. the properties) owned by the class. + + \sa addOwnedAttribute(), removeOwnedAttribute() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(), QUmlClassifier::attributes(). + + \b {Redefined property(ies):} QUmlStructuredClassifier::ownedAttributes(). + + \b {Opposite property(ies):} QUmlProperty::class_(). */ const QList<QUmlProperty *> QUmlClass::ownedAttributes() const { @@ -301,6 +352,11 @@ const QList<QUmlProperty *> QUmlClass::ownedAttributes() const return _ownedAttributes; } +/*! + Adds \a ownedAttribute to ownedAttributes. + + \sa ownedAttributes(), removeOwnedAttribute() + */ void QUmlClass::addOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end @@ -325,6 +381,11 @@ void QUmlClass::addOwnedAttribute(QUmlProperty *ownedAttribute) } } +/*! + Removes \a ownedAttribute from ownedAttributes. + + \sa ownedAttributes(), addOwnedAttribute() + */ void QUmlClass::removeOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end @@ -350,6 +411,12 @@ void QUmlClass::removeOwnedAttribute(QUmlProperty *ownedAttribute) /*! The operations owned by the class. + + \sa addOwnedOperation(), removeOwnedOperation() + + \b {Subsetted property(ies):} QUmlClassifier::features(), QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlOperation::class_(). */ const QList<QUmlOperation *> QUmlClass::ownedOperations() const { @@ -358,6 +425,11 @@ const QList<QUmlOperation *> QUmlClass::ownedOperations() const return _ownedOperations; } +/*! + Adds \a ownedOperation to ownedOperations. + + \sa ownedOperations(), removeOwnedOperation() + */ void QUmlClass::addOwnedOperation(QUmlOperation *ownedOperation) { // This is a read-write association end @@ -379,6 +451,11 @@ void QUmlClass::addOwnedOperation(QUmlOperation *ownedOperation) } } +/*! + Removes \a ownedOperation from ownedOperations. + + \sa ownedOperations(), addOwnedOperation() + */ void QUmlClass::removeOwnedOperation(QUmlOperation *ownedOperation) { // This is a read-write association end @@ -401,6 +478,10 @@ void QUmlClass::removeOwnedOperation(QUmlOperation *ownedOperation) /*! Receptions that objects of this class are willing to accept. + + \sa addOwnedReception(), removeOwnedReception() + + \b {Subsetted property(ies):} QUmlClassifier::features(), QUmlNamespace::ownedMembers(). */ const QSet<QUmlReception *> QUmlClass::ownedReceptions() const { @@ -409,6 +490,11 @@ const QSet<QUmlReception *> QUmlClass::ownedReceptions() const return _ownedReceptions; } +/*! + Adds \a ownedReception to ownedReceptions. + + \sa ownedReceptions(), removeOwnedReception() + */ void QUmlClass::addOwnedReception(QUmlReception *ownedReception) { // This is a read-write association end @@ -425,6 +511,11 @@ void QUmlClass::addOwnedReception(QUmlReception *ownedReception) } } +/*! + Removes \a ownedReception from ownedReceptions. + + \sa ownedReceptions(), addOwnedReception() + */ void QUmlClass::removeOwnedReception(QUmlReception *ownedReception) { // This is a read-write association end @@ -442,6 +533,12 @@ void QUmlClass::removeOwnedReception(QUmlReception *ownedReception) /*! This gives the superclasses of a class. + + \sa addSuperClass(), removeSuperClass() + + \b {This is a derived property.} + + \b {Redefined property(ies):} QUmlClassifier::generals(). */ const QSet<QUmlClass *> QUmlClass::superClasses() const { @@ -452,6 +549,11 @@ const QSet<QUmlClass *> QUmlClass::superClasses() const return QSet<QUmlClass *>(); } +/*! + Adds \a superClass to superClasses. + + \sa superClasses(), removeSuperClass() + */ void QUmlClass::addSuperClass(QUmlClass *superClass) { // This is a read-write derived association end @@ -467,6 +569,11 @@ void QUmlClass::addSuperClass(QUmlClass *superClass) } } +/*! + Removes \a superClass from superClasses. + + \sa superClasses(), addSuperClass() + */ void QUmlClass::removeSuperClass(QUmlClass *superClass) { // This is a read-write derived association end diff --git a/src/uml/qumlclass.h b/src/uml/qumlclass.h index 5339b18e..81e4475c 100644 --- a/src/uml/qumlclass.h +++ b/src/uml/qumlclass.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlEncapsulatedClassifier> #include <QtUml/QUmlBehavioredClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -106,7 +104,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlClass) *) -QT_END_HEADER - #endif // QUMLCLASS_H diff --git a/src/uml/qumlclassifier.cpp b/src/uml/qumlclassifier.cpp index 53f7226d..b9325397 100644 --- a/src/uml/qumlclassifier.cpp +++ b/src/uml/qumlclassifier.cpp @@ -72,7 +72,13 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A classifier is a classification of instances - it describes a set of instances that have features in common. A classifier can specify a generalization hierarchy by referencing its general classifiers.A classifier has the capability to own use cases. Although the owning classifier typically represents the subject to which the owned use cases apply, this is not necessarily the case. In principle, the same use case can be applied to multiple subjects, as identified by the subject association role of a use case.Classifier is defined to be a kind of templateable element so that a classifier can be parameterized. It is also defined to be a kind of parameterable element so that a classifier can be a formal template parameter.A classifier has the capability to own collaboration uses. These collaboration uses link a collaboration with the classifier to give a description of the workings of the classifier. + + \b {QUmlClassifier is an abstract class.} */ + +/*! + Creates a new QUmlClassifier. +*/ QUmlClassifier::QUmlClassifier() : _isAbstract(false), _isFinalSpecialization(false), @@ -82,6 +88,9 @@ QUmlClassifier::QUmlClassifier() : { } +/*! + Returns a deep-copied clone of the QUmlClassifier. +*/ QModelingElement *QUmlClassifier::clone() const { QUmlClassifier *c = new QUmlClassifier; @@ -135,6 +144,10 @@ QModelingElement *QUmlClassifier::clone() const /*! Refers to all of the Properties that are direct (i.e. not inherited or imported) attributes of the classifier. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} QUmlClassifier::features(), . */ const QSet<QUmlProperty *> QUmlClassifier::attributes() const { @@ -143,6 +156,11 @@ const QSet<QUmlProperty *> QUmlClassifier::attributes() const return _attributes; } +/*! + Adds \a attribute to attributes. + + \sa attributes(), removeAttribute() + */ void QUmlClassifier::addAttribute(QUmlProperty *attribute) { // This is a read-only derived union association end @@ -157,6 +175,11 @@ void QUmlClassifier::addAttribute(QUmlProperty *attribute) } } +/*! + Removes \a attribute from attributes. + + \sa attributes(), addAttribute() + */ void QUmlClassifier::removeAttribute(QUmlProperty *attribute) { // This is a read-only derived union association end @@ -171,6 +194,10 @@ void QUmlClassifier::removeAttribute(QUmlProperty *attribute) /*! References the collaboration uses owned by the classifier. + + \sa addCollaborationUse(), removeCollaborationUse() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlCollaborationUse *> QUmlClassifier::collaborationUses() const { @@ -179,6 +206,11 @@ const QSet<QUmlCollaborationUse *> QUmlClassifier::collaborationUses() const return _collaborationUses; } +/*! + Adds \a collaborationUse to collaborationUses. + + \sa collaborationUses(), removeCollaborationUse() + */ void QUmlClassifier::addCollaborationUse(QUmlCollaborationUse *collaborationUse) { // This is a read-write association end @@ -194,6 +226,11 @@ void QUmlClassifier::addCollaborationUse(QUmlCollaborationUse *collaborationUse) } } +/*! + Removes \a collaborationUse from collaborationUses. + + \sa collaborationUses(), addCollaborationUse() + */ void QUmlClassifier::removeCollaborationUse(QUmlCollaborationUse *collaborationUse) { // This is a read-write association end @@ -210,6 +247,12 @@ void QUmlClassifier::removeCollaborationUse(QUmlCollaborationUse *collaborationU /*! Specifies each feature defined in the classifier.Note that there may be members of the Classifier that are of the type Feature but are not included in this association, e.g. inherited features. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} QUmlNamespace::members(). + + \b {Opposite property(ies):} QUmlFeature::featuringClassifiers(). */ const QSet<QUmlFeature *> QUmlClassifier::features() const { @@ -218,6 +261,11 @@ const QSet<QUmlFeature *> QUmlClassifier::features() const return _features; } +/*! + Adds \a feature to features. + + \sa features(), removeFeature() + */ void QUmlClassifier::addFeature(QUmlFeature *feature) { // This is a read-only derived union association end @@ -237,6 +285,11 @@ void QUmlClassifier::addFeature(QUmlFeature *feature) } } +/*! + Removes \a feature from features. + + \sa features(), addFeature() + */ void QUmlClassifier::removeFeature(QUmlFeature *feature) { // This is a read-only derived union association end @@ -256,6 +309,10 @@ void QUmlClassifier::removeFeature(QUmlFeature *feature) /*! Specifies the general Classifiers for this Classifier.References the general classifier in the Generalization relationship. + + \sa addGeneral(), removeGeneral() + + \b {This is a derived property.} */ const QSet<QUmlClassifier *> QUmlClassifier::generals() const { @@ -266,6 +323,11 @@ const QSet<QUmlClassifier *> QUmlClassifier::generals() const return QSet<QUmlClassifier *>(); } +/*! + Adds \a general to generals. + + \sa generals(), removeGeneral() + */ void QUmlClassifier::addGeneral(QUmlClassifier *general) { // This is a read-write derived association end @@ -278,6 +340,11 @@ void QUmlClassifier::addGeneral(QUmlClassifier *general) } } +/*! + Removes \a general from generals. + + \sa generals(), addGeneral() + */ void QUmlClassifier::removeGeneral(QUmlClassifier *general) { // This is a read-write derived association end @@ -292,6 +359,12 @@ void QUmlClassifier::removeGeneral(QUmlClassifier *general) /*! Specifies the Generalization relationships for this Classifier. These Generalizations navigaten to more general classifiers in the generalization hierarchy. + + \sa addGeneralization(), removeGeneralization() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlGeneralization::specific(). */ const QSet<QUmlGeneralization *> QUmlClassifier::generalizations() const { @@ -300,6 +373,11 @@ const QSet<QUmlGeneralization *> QUmlClassifier::generalizations() const return _generalizations; } +/*! + Adds \a generalization to generalizations. + + \sa generalizations(), removeGeneralization() + */ void QUmlClassifier::addGeneralization(QUmlGeneralization *generalization) { // This is a read-write association end @@ -320,6 +398,11 @@ void QUmlClassifier::addGeneralization(QUmlGeneralization *generalization) } } +/*! + Removes \a generalization from generalizations. + + \sa generalizations(), addGeneralization() + */ void QUmlClassifier::removeGeneralization(QUmlGeneralization *generalization) { // This is a read-write association end @@ -341,6 +424,10 @@ void QUmlClassifier::removeGeneralization(QUmlGeneralization *generalization) /*! Specifies all elements inherited by this classifier from the general classifiers. + + \b {This is a read-only derived property.} + + \b {Subsetted property(ies):} QUmlNamespace::members(). */ const QSet<QUmlNamedElement *> QUmlClassifier::inheritedMembers() const { @@ -351,6 +438,11 @@ const QSet<QUmlNamedElement *> QUmlClassifier::inheritedMembers() const return QSet<QUmlNamedElement *>(); } +/*! + Adds \a inheritedMember to inheritedMembers. + + \sa inheritedMembers(), removeInheritedMember() + */ void QUmlClassifier::addInheritedMember(QUmlNamedElement *inheritedMember) { // This is a read-only derived association end @@ -366,6 +458,11 @@ void QUmlClassifier::addInheritedMember(QUmlNamedElement *inheritedMember) } } +/*! + Removes \a inheritedMember from inheritedMembers. + + \sa inheritedMembers(), addInheritedMember() + */ void QUmlClassifier::removeInheritedMember(QUmlNamedElement *inheritedMember) { // This is a read-only derived association end @@ -391,6 +488,9 @@ bool QUmlClassifier::isAbstract() const return _isAbstract; } +/*! + Adjusts isAbstract to \a isAbstract. + */ void QUmlClassifier::setAbstract(bool isAbstract) { // This is a read-write property @@ -411,6 +511,9 @@ bool QUmlClassifier::isFinalSpecialization() const return _isFinalSpecialization; } +/*! + Adjusts isFinalSpecialization to \a isFinalSpecialization. + */ void QUmlClassifier::setFinalSpecialization(bool isFinalSpecialization) { // This is a read-write property @@ -423,6 +526,12 @@ void QUmlClassifier::setFinalSpecialization(bool isFinalSpecialization) /*! The optional template signature specifying the formal template parameters. + + \b {Subsetted property(ies):} . + + \b {Redefined property(ies):} QUmlTemplateableElement::ownedTemplateSignature(). + + \b {Opposite property(ies):} QUmlRedefinableTemplateSignature::classifier(). */ QUmlRedefinableTemplateSignature *QUmlClassifier::ownedTemplateSignature() const { @@ -431,6 +540,9 @@ QUmlRedefinableTemplateSignature *QUmlClassifier::ownedTemplateSignature() const return _ownedTemplateSignature; } +/*! + Adjusts ownedTemplateSignature to \a ownedTemplateSignature. + */ void QUmlClassifier::setOwnedTemplateSignature(QUmlRedefinableTemplateSignature *ownedTemplateSignature) { // This is a read-write association end @@ -448,6 +560,10 @@ void QUmlClassifier::setOwnedTemplateSignature(QUmlRedefinableTemplateSignature /*! References the use cases owned by this classifier. + + \sa addOwnedUseCase(), removeOwnedUseCase() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QSet<QUmlUseCase *> QUmlClassifier::ownedUseCases() const { @@ -456,6 +572,11 @@ const QSet<QUmlUseCase *> QUmlClassifier::ownedUseCases() const return _ownedUseCases; } +/*! + Adds \a ownedUseCase to ownedUseCases. + + \sa ownedUseCases(), removeOwnedUseCase() + */ void QUmlClassifier::addOwnedUseCase(QUmlUseCase *ownedUseCase) { // This is a read-write association end @@ -471,6 +592,11 @@ void QUmlClassifier::addOwnedUseCase(QUmlUseCase *ownedUseCase) } } +/*! + Removes \a ownedUseCase from ownedUseCases. + + \sa ownedUseCases(), addOwnedUseCase() + */ void QUmlClassifier::removeOwnedUseCase(QUmlUseCase *ownedUseCase) { // This is a read-write association end @@ -487,6 +613,10 @@ void QUmlClassifier::removeOwnedUseCase(QUmlUseCase *ownedUseCase) /*! Designates the GeneralizationSet of which the associated Classifier is a power type. + + \sa addPowertypeExtent(), removePowertypeExtent() + + \b {Opposite property(ies):} QUmlGeneralizationSet::powertype(). */ const QSet<QUmlGeneralizationSet *> QUmlClassifier::powertypeExtents() const { @@ -495,6 +625,11 @@ const QSet<QUmlGeneralizationSet *> QUmlClassifier::powertypeExtents() const return _powertypeExtents; } +/*! + Adds \a powertypeExtent to powertypeExtents. + + \sa powertypeExtents(), removePowertypeExtent() + */ void QUmlClassifier::addPowertypeExtent(QUmlGeneralizationSet *powertypeExtent) { // This is a read-write association end @@ -511,6 +646,11 @@ void QUmlClassifier::addPowertypeExtent(QUmlGeneralizationSet *powertypeExtent) } } +/*! + Removes \a powertypeExtent from powertypeExtents. + + \sa powertypeExtents(), addPowertypeExtent() + */ void QUmlClassifier::removePowertypeExtent(QUmlGeneralizationSet *powertypeExtent) { // This is a read-write association end @@ -527,6 +667,10 @@ void QUmlClassifier::removePowertypeExtent(QUmlGeneralizationSet *powertypeExten /*! References the Classifiers that are redefined by this Classifier. + + \sa addRedefinedClassifier(), removeRedefinedClassifier() + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinedElements(). */ const QSet<QUmlClassifier *> QUmlClassifier::redefinedClassifiers() const { @@ -535,6 +679,11 @@ const QSet<QUmlClassifier *> QUmlClassifier::redefinedClassifiers() const return _redefinedClassifiers; } +/*! + Adds \a redefinedClassifier to redefinedClassifiers. + + \sa redefinedClassifiers(), removeRedefinedClassifier() + */ void QUmlClassifier::addRedefinedClassifier(QUmlClassifier *redefinedClassifier) { // This is a read-write association end @@ -549,6 +698,11 @@ void QUmlClassifier::addRedefinedClassifier(QUmlClassifier *redefinedClassifier) } } +/*! + Removes \a redefinedClassifier from redefinedClassifiers. + + \sa redefinedClassifiers(), addRedefinedClassifier() + */ void QUmlClassifier::removeRedefinedClassifier(QUmlClassifier *redefinedClassifier) { // This is a read-write association end @@ -563,6 +717,8 @@ void QUmlClassifier::removeRedefinedClassifier(QUmlClassifier *redefinedClassifi /*! References a collaboration use which indicates the collaboration that represents this classifier. + + \b {Subsetted property(ies):} QUmlClassifier::collaborationUses(). */ QUmlCollaborationUse *QUmlClassifier::representation() const { @@ -571,6 +727,9 @@ QUmlCollaborationUse *QUmlClassifier::representation() const return _representation; } +/*! + Adjusts representation to \a representation. + */ void QUmlClassifier::setRepresentation(QUmlCollaborationUse *representation) { // This is a read-write association end @@ -592,6 +751,12 @@ void QUmlClassifier::setRepresentation(QUmlCollaborationUse *representation) /*! References the substitutions that are owned by this Classifier. + + \sa addSubstitution(), removeSubstitution() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(), QUmlNamedElement::clientDependencies(). + + \b {Opposite property(ies):} QUmlSubstitution::substitutingClassifier(). */ const QSet<QUmlSubstitution *> QUmlClassifier::substitutions() const { @@ -600,6 +765,11 @@ const QSet<QUmlSubstitution *> QUmlClassifier::substitutions() const return _substitutions; } +/*! + Adds \a substitution to substitutions. + + \sa substitutions(), removeSubstitution() + */ void QUmlClassifier::addSubstitution(QUmlSubstitution *substitution) { // This is a read-write association end @@ -621,6 +791,11 @@ void QUmlClassifier::addSubstitution(QUmlSubstitution *substitution) } } +/*! + Removes \a substitution from substitutions. + + \sa substitutions(), addSubstitution() + */ void QUmlClassifier::removeSubstitution(QUmlSubstitution *substitution) { // This is a read-write association end @@ -643,6 +818,10 @@ void QUmlClassifier::removeSubstitution(QUmlSubstitution *substitution) /*! The template parameter that exposes this element as a formal parameter. + + \b {Redefined property(ies):} QUmlParameterableElement::templateParameter(). + + \b {Opposite property(ies):} QUmlClassifierTemplateParameter::parameteredElement(). */ QUmlClassifierTemplateParameter *QUmlClassifier::templateParameter() const { @@ -651,6 +830,9 @@ QUmlClassifierTemplateParameter *QUmlClassifier::templateParameter() const return _templateParameter; } +/*! + Adjusts templateParameter to \a templateParameter. + */ void QUmlClassifier::setTemplateParameter(QUmlClassifierTemplateParameter *templateParameter) { // This is a read-write association end @@ -667,6 +849,10 @@ void QUmlClassifier::setTemplateParameter(QUmlClassifierTemplateParameter *templ /*! The set of use cases for which this Classifier is the subject. + + \sa addUseCase(), removeUseCase() + + \b {Opposite property(ies):} QUmlUseCase::subjects(). */ const QSet<QUmlUseCase *> QUmlClassifier::useCases() const { @@ -675,6 +861,11 @@ const QSet<QUmlUseCase *> QUmlClassifier::useCases() const return _useCases; } +/*! + Adds \a useCase to useCases. + + \sa useCases(), removeUseCase() + */ void QUmlClassifier::addUseCase(QUmlUseCase *useCase) { // This is a read-write association end @@ -691,6 +882,11 @@ void QUmlClassifier::addUseCase(QUmlUseCase *useCase) } } +/*! + Removes \a useCase from useCases. + + \sa useCases(), addUseCase() + */ void QUmlClassifier::removeUseCase(QUmlUseCase *useCase) { // This is a read-write association end diff --git a/src/uml/qumlclassifier.h b/src/uml/qumlclassifier.h index 68ec91b1..3c6933d3 100644 --- a/src/uml/qumlclassifier.h +++ b/src/uml/qumlclassifier.h @@ -48,8 +48,6 @@ #include <QtUml/QUmlRedefinableElement> #include <QtUml/QUmlTemplateableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -149,7 +147,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlClassifier) *) -QT_END_HEADER - #endif // QUMLCLASSIFIER_H diff --git a/src/uml/qumlclassifiertemplateparameter.cpp b/src/uml/qumlclassifiertemplateparameter.cpp index 52a991e1..16447a0f 100644 --- a/src/uml/qumlclassifiertemplateparameter.cpp +++ b/src/uml/qumlclassifiertemplateparameter.cpp @@ -57,6 +57,10 @@ QT_BEGIN_NAMESPACE \brief A classifier template parameter exposes a classifier as a formal template parameter. */ + +/*! + Creates a new QUmlClassifierTemplateParameter. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlClassifierTemplateParameter::QUmlClassifierTemplateParameter(bool createQModelingObject) : QUmlTemplateParameter(false), _allowSubstitutable(true), @@ -66,6 +70,9 @@ QUmlClassifierTemplateParameter::QUmlClassifierTemplateParameter(bool createQMod _qModelingObject = qobject_cast<QModelingObject *>(new QUmlClassifierTemplateParameterObject(this)); } +/*! + Returns a deep-copied clone of the QUmlClassifierTemplateParameter. +*/ QModelingElement *QUmlClassifierTemplateParameter::clone() const { QUmlClassifierTemplateParameter *c = new QUmlClassifierTemplateParameter; @@ -99,6 +106,9 @@ bool QUmlClassifierTemplateParameter::allowSubstitutable() const return _allowSubstitutable; } +/*! + Adjusts allowSubstitutable to \a allowSubstitutable. + */ void QUmlClassifierTemplateParameter::setAllowSubstitutable(bool allowSubstitutable) { // This is a read-write property @@ -111,6 +121,8 @@ void QUmlClassifierTemplateParameter::setAllowSubstitutable(bool allowSubstituta /*! The classifiers that constrain the argument that can be used for the parameter. If the allowSubstitutable attribute is true, then any classifier that is compatible with this constraining classifier can be substituted; otherwise, it must be either this classifier or one of its subclasses. If this property is empty, there are no constraints on the classifier that can be used as an argument. + + \sa addConstrainingClassifier(), removeConstrainingClassifier() */ const QSet<QUmlClassifier *> QUmlClassifierTemplateParameter::constrainingClassifiers() const { @@ -119,6 +131,11 @@ const QSet<QUmlClassifier *> QUmlClassifierTemplateParameter::constrainingClassi return _constrainingClassifiers; } +/*! + Adds \a constrainingClassifier to constrainingClassifiers. + + \sa constrainingClassifiers(), removeConstrainingClassifier() + */ void QUmlClassifierTemplateParameter::addConstrainingClassifier(QUmlClassifier *constrainingClassifier) { // This is a read-write association end @@ -130,6 +147,11 @@ void QUmlClassifierTemplateParameter::addConstrainingClassifier(QUmlClassifier * } } +/*! + Removes \a constrainingClassifier from constrainingClassifiers. + + \sa constrainingClassifiers(), addConstrainingClassifier() + */ void QUmlClassifierTemplateParameter::removeConstrainingClassifier(QUmlClassifier *constrainingClassifier) { // This is a read-write association end @@ -141,6 +163,10 @@ void QUmlClassifierTemplateParameter::removeConstrainingClassifier(QUmlClassifie /*! The parameterable classifier for this template parameter. + + \b {Redefined property(ies):} QUmlTemplateParameter::parameteredElement(). + + \b {Opposite property(ies):} QUmlClassifier::templateParameter(). */ QUmlClassifier *QUmlClassifierTemplateParameter::parameteredElement() const { @@ -149,6 +175,9 @@ QUmlClassifier *QUmlClassifierTemplateParameter::parameteredElement() const return _parameteredElement; } +/*! + Adjusts parameteredElement to \a parameteredElement. + */ void QUmlClassifierTemplateParameter::setParameteredElement(QUmlClassifier *parameteredElement) { // This is a read-write association end diff --git a/src/uml/qumlclassifiertemplateparameter.h b/src/uml/qumlclassifiertemplateparameter.h index aa51711a..ec89ee91 100644 --- a/src/uml/qumlclassifiertemplateparameter.h +++ b/src/uml/qumlclassifiertemplateparameter.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlTemplateParameter> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -79,7 +77,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlClassifierTemplateParameter) *) -QT_END_HEADER - #endif // QUMLCLASSIFIERTEMPLATEPARAMETER_H diff --git a/src/uml/qumlclause.cpp b/src/uml/qumlclause.cpp index 51039595..2f8a8556 100644 --- a/src/uml/qumlclause.cpp +++ b/src/uml/qumlclause.cpp @@ -55,6 +55,10 @@ QT_BEGIN_NAMESPACE \brief A clause is an element that represents a single branch of a conditional construct, including a test and a body section. The body section is executed only if (but not necessarily if) the test section evaluates true. */ + +/*! + Creates a new QUmlClause. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlClause::QUmlClause(bool createQModelingObject) : _decider(0) { @@ -62,6 +66,9 @@ QUmlClause::QUmlClause(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlClauseObject(this)); } +/*! + Returns a deep-copied clone of the QUmlClause. +*/ QModelingElement *QUmlClause::clone() const { QUmlClause *c = new QUmlClause; @@ -86,6 +93,8 @@ QModelingElement *QUmlClause::clone() const /*! A nested activity fragment that is executed if the test evaluates to true and the clause is chosen over any concurrent clauses that also evaluate to true. + + \sa addBody(), removeBody() */ const QSet<QUmlExecutableNode *> QUmlClause::bodies() const { @@ -94,6 +103,11 @@ const QSet<QUmlExecutableNode *> QUmlClause::bodies() const return _bodies; } +/*! + Adds \a body to bodies. + + \sa bodies(), removeBody() + */ void QUmlClause::addBody(QUmlExecutableNode *body) { // This is a read-write association end @@ -105,6 +119,11 @@ void QUmlClause::addBody(QUmlExecutableNode *body) } } +/*! + Removes \a body from bodies. + + \sa bodies(), addBody() + */ void QUmlClause::removeBody(QUmlExecutableNode *body) { // This is a read-write association end @@ -116,6 +135,8 @@ void QUmlClause::removeBody(QUmlExecutableNode *body) /*! A list of output pins within the body fragment whose values are moved to the result pins of the containing conditional node after execution of the clause body. + + \sa addBodyOutput(), removeBodyOutput() */ const QList<QUmlOutputPin *> QUmlClause::bodyOutputs() const { @@ -124,6 +145,11 @@ const QList<QUmlOutputPin *> QUmlClause::bodyOutputs() const return _bodyOutputs; } +/*! + Adds \a bodyOutput to bodyOutputs. + + \sa bodyOutputs(), removeBodyOutput() + */ void QUmlClause::addBodyOutput(QUmlOutputPin *bodyOutput) { // This is a read-write association end @@ -135,6 +161,11 @@ void QUmlClause::addBodyOutput(QUmlOutputPin *bodyOutput) } } +/*! + Removes \a bodyOutput from bodyOutputs. + + \sa bodyOutputs(), addBodyOutput() + */ void QUmlClause::removeBodyOutput(QUmlOutputPin *bodyOutput) { // This is a read-write association end @@ -154,6 +185,9 @@ QUmlOutputPin *QUmlClause::decider() const return _decider; } +/*! + Adjusts decider to \a decider. + */ void QUmlClause::setDecider(QUmlOutputPin *decider) { // This is a read-write association end @@ -167,6 +201,10 @@ void QUmlClause::setDecider(QUmlOutputPin *decider) /*! A set of clauses whose tests must all evaluate false before the current clause can be tested. + + \sa addPredecessorClause(), removePredecessorClause() + + \b {Opposite property(ies):} QUmlClause::successorClauses(). */ const QSet<QUmlClause *> QUmlClause::predecessorClauses() const { @@ -175,6 +213,11 @@ const QSet<QUmlClause *> QUmlClause::predecessorClauses() const return _predecessorClauses; } +/*! + Adds \a predecessorClause to predecessorClauses. + + \sa predecessorClauses(), removePredecessorClause() + */ void QUmlClause::addPredecessorClause(QUmlClause *predecessorClause) { // This is a read-write association end @@ -191,6 +234,11 @@ void QUmlClause::addPredecessorClause(QUmlClause *predecessorClause) } } +/*! + Removes \a predecessorClause from predecessorClauses. + + \sa predecessorClauses(), addPredecessorClause() + */ void QUmlClause::removePredecessorClause(QUmlClause *predecessorClause) { // This is a read-write association end @@ -207,6 +255,10 @@ void QUmlClause::removePredecessorClause(QUmlClause *predecessorClause) /*! A set of clauses which may not be tested unless the current clause tests false. + + \sa addSuccessorClause(), removeSuccessorClause() + + \b {Opposite property(ies):} QUmlClause::predecessorClauses(). */ const QSet<QUmlClause *> QUmlClause::successorClauses() const { @@ -215,6 +267,11 @@ const QSet<QUmlClause *> QUmlClause::successorClauses() const return _successorClauses; } +/*! + Adds \a successorClause to successorClauses. + + \sa successorClauses(), removeSuccessorClause() + */ void QUmlClause::addSuccessorClause(QUmlClause *successorClause) { // This is a read-write association end @@ -231,6 +288,11 @@ void QUmlClause::addSuccessorClause(QUmlClause *successorClause) } } +/*! + Removes \a successorClause from successorClauses. + + \sa successorClauses(), addSuccessorClause() + */ void QUmlClause::removeSuccessorClause(QUmlClause *successorClause) { // This is a read-write association end @@ -247,6 +309,8 @@ void QUmlClause::removeSuccessorClause(QUmlClause *successorClause) /*! A nested activity fragment with a designated output pin that specifies the result of the test. + + \sa addTest(), removeTest() */ const QSet<QUmlExecutableNode *> QUmlClause::tests() const { @@ -255,6 +319,11 @@ const QSet<QUmlExecutableNode *> QUmlClause::tests() const return _tests; } +/*! + Adds \a test to tests. + + \sa tests(), removeTest() + */ void QUmlClause::addTest(QUmlExecutableNode *test) { // This is a read-write association end @@ -266,6 +335,11 @@ void QUmlClause::addTest(QUmlExecutableNode *test) } } +/*! + Removes \a test from tests. + + \sa tests(), addTest() + */ void QUmlClause::removeTest(QUmlExecutableNode *test) { // This is a read-write association end diff --git a/src/uml/qumlclause.h b/src/uml/qumlclause.h index 491dc57a..24ed1794 100644 --- a/src/uml/qumlclause.h +++ b/src/uml/qumlclause.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -93,7 +91,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlClause) *) -QT_END_HEADER - #endif // QUMLCLAUSE_H diff --git a/src/uml/qumlclearassociationaction.cpp b/src/uml/qumlclearassociationaction.cpp index db282e63..f7fe85c6 100644 --- a/src/uml/qumlclearassociationaction.cpp +++ b/src/uml/qumlclearassociationaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A clear association action is an action that destroys all links of an association in which a particular object participates. */ + +/*! + Creates a new QUmlClearAssociationAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlClearAssociationAction::QUmlClearAssociationAction(bool createQModelingObject) : _association(0), _object(0) @@ -81,6 +85,9 @@ QUmlClearAssociationAction::QUmlClearAssociationAction(bool createQModelingObjec _qModelingObject = qobject_cast<QModelingObject *>(new QUmlClearAssociationActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlClearAssociationAction. +*/ QModelingElement *QUmlClearAssociationAction::clone() const { QUmlClearAssociationAction *c = new QUmlClearAssociationAction; @@ -133,6 +140,9 @@ QUmlAssociation *QUmlClearAssociationAction::association() const return _association; } +/*! + Adjusts association to \a association. + */ void QUmlClearAssociationAction::setAssociation(QUmlAssociation *association) { // This is a read-write association end @@ -146,6 +156,8 @@ void QUmlClearAssociationAction::setAssociation(QUmlAssociation *association) /*! Gives the input pin from which is obtained the object whose participation in the association is to be cleared. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlClearAssociationAction::object() const { @@ -154,6 +166,9 @@ QUmlInputPin *QUmlClearAssociationAction::object() const return _object; } +/*! + Adjusts object to \a object. + */ void QUmlClearAssociationAction::setObject(QUmlInputPin *object) { // This is a read-write association end diff --git a/src/uml/qumlclearassociationaction.h b/src/uml/qumlclearassociationaction.h index c7af1f2e..841225b1 100644 --- a/src/uml/qumlclearassociationaction.h +++ b/src/uml/qumlclearassociationaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlClearAssociationAction) *) -QT_END_HEADER - #endif // QUMLCLEARASSOCIATIONACTION_H diff --git a/src/uml/qumlclearstructuralfeatureaction.cpp b/src/uml/qumlclearstructuralfeatureaction.cpp index fcd3e323..9b5b1d43 100644 --- a/src/uml/qumlclearstructuralfeatureaction.cpp +++ b/src/uml/qumlclearstructuralfeatureaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A clear structural feature action is a structural feature action that removes all values of a structural feature. */ + +/*! + Creates a new QUmlClearStructuralFeatureAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlClearStructuralFeatureAction::QUmlClearStructuralFeatureAction(bool createQModelingObject) : _result(0) { @@ -80,6 +84,9 @@ QUmlClearStructuralFeatureAction::QUmlClearStructuralFeatureAction(bool createQM _qModelingObject = qobject_cast<QModelingObject *>(new QUmlClearStructuralFeatureActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlClearStructuralFeatureAction. +*/ QModelingElement *QUmlClearStructuralFeatureAction::clone() const { QUmlClearStructuralFeatureAction *c = new QUmlClearStructuralFeatureAction; @@ -126,6 +133,8 @@ QModelingElement *QUmlClearStructuralFeatureAction::clone() const /*! Gives the output pin on which the result is put. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlClearStructuralFeatureAction::result() const { @@ -134,6 +143,9 @@ QUmlOutputPin *QUmlClearStructuralFeatureAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlClearStructuralFeatureAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlclearstructuralfeatureaction.h b/src/uml/qumlclearstructuralfeatureaction.h index 29cfec1f..28d9f978 100644 --- a/src/uml/qumlclearstructuralfeatureaction.h +++ b/src/uml/qumlclearstructuralfeatureaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlStructuralFeatureAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlClearStructuralFeatureAction) *) -QT_END_HEADER - #endif // QUMLCLEARSTRUCTURALFEATUREACTION_H diff --git a/src/uml/qumlclearvariableaction.cpp b/src/uml/qumlclearvariableaction.cpp index 6475f03f..b3f88d35 100644 --- a/src/uml/qumlclearvariableaction.cpp +++ b/src/uml/qumlclearvariableaction.cpp @@ -73,12 +73,19 @@ QT_BEGIN_NAMESPACE \brief A clear variable action is a variable action that removes all values of a variable. */ + +/*! + Creates a new QUmlClearVariableAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlClearVariableAction::QUmlClearVariableAction(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlClearVariableActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlClearVariableAction. +*/ QModelingElement *QUmlClearVariableAction::clone() const { QUmlClearVariableAction *c = new QUmlClearVariableAction; diff --git a/src/uml/qumlclearvariableaction.h b/src/uml/qumlclearvariableaction.h index 7632e361..2a6eb71f 100644 --- a/src/uml/qumlclearvariableaction.h +++ b/src/uml/qumlclearvariableaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlVariableAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlClearVariableAction) *) -QT_END_HEADER - #endif // QUMLCLEARVARIABLEACTION_H diff --git a/src/uml/qumlcollaboration.cpp b/src/uml/qumlcollaboration.cpp index cf09d983..0ef20787 100644 --- a/src/uml/qumlcollaboration.cpp +++ b/src/uml/qumlcollaboration.cpp @@ -83,12 +83,19 @@ QT_BEGIN_NAMESPACE \brief A collaboration use represents the application of the pattern described by a collaboration to a specific situation involving specific classes or instances playing the roles of the collaboration. */ + +/*! + Creates a new QUmlCollaboration. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlCollaboration::QUmlCollaboration(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCollaborationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlCollaboration. +*/ QModelingElement *QUmlCollaboration::clone() const { QUmlCollaboration *c = new QUmlCollaboration; @@ -154,6 +161,10 @@ QModelingElement *QUmlCollaboration::clone() const /*! References connectable elements (possibly owned by other classifiers) which represent roles that instances may play in this collaboration. + + \sa addCollaborationRole(), removeCollaborationRole() + + \b {Subsetted property(ies):} QUmlStructuredClassifier::roles(). */ const QSet<QUmlConnectableElement *> QUmlCollaboration::collaborationRoles() const { @@ -162,6 +173,11 @@ const QSet<QUmlConnectableElement *> QUmlCollaboration::collaborationRoles() con return _collaborationRoles; } +/*! + Adds \a collaborationRole to collaborationRoles. + + \sa collaborationRoles(), removeCollaborationRole() + */ void QUmlCollaboration::addCollaborationRole(QUmlConnectableElement *collaborationRole) { // This is a read-write association end @@ -176,6 +192,11 @@ void QUmlCollaboration::addCollaborationRole(QUmlConnectableElement *collaborati } } +/*! + Removes \a collaborationRole from collaborationRoles. + + \sa collaborationRoles(), addCollaborationRole() + */ void QUmlCollaboration::removeCollaborationRole(QUmlConnectableElement *collaborationRole) { // This is a read-write association end diff --git a/src/uml/qumlcollaboration.h b/src/uml/qumlcollaboration.h index 41e70ba3..11f3c9ae 100644 --- a/src/uml/qumlcollaboration.h +++ b/src/uml/qumlcollaboration.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlStructuredClassifier> #include <QtUml/QUmlBehavioredClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -74,7 +72,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCollaboration) *) -QT_END_HEADER - #endif // QUMLCOLLABORATION_H diff --git a/src/uml/qumlcollaborationuse.cpp b/src/uml/qumlcollaborationuse.cpp index 0dae62b8..2ec87bb4 100644 --- a/src/uml/qumlcollaborationuse.cpp +++ b/src/uml/qumlcollaborationuse.cpp @@ -59,6 +59,10 @@ QT_BEGIN_NAMESPACE \brief A collaboration use represents one particular use of a collaboration to explain the relationships between the properties of a classifier. A collaboration use shows how the pattern described by a collaboration is applied in a given context, by binding specific entities from that context to the roles of the collaboration. Depending on the context, these entities could be structural features of a classifier, instance specifications, or even roles in some containing collaboration. There may be multiple occurrences of a given collaboration within a classifier, each involving a different set of roles and connectors. A given role or connector may be involved in multiple occurrences of the same or different collaborations. Associated dependencies map features of the collaboration type to features in the classifier. These dependencies indicate which role in the classifier plays which role in the collaboration. */ + +/*! + Creates a new QUmlCollaborationUse. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlCollaborationUse::QUmlCollaborationUse(bool createQModelingObject) : _type(0) { @@ -66,6 +70,9 @@ QUmlCollaborationUse::QUmlCollaborationUse(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCollaborationUseObject(this)); } +/*! + Returns a deep-copied clone of the QUmlCollaborationUse. +*/ QModelingElement *QUmlCollaborationUse::clone() const { QUmlCollaborationUse *c = new QUmlCollaborationUse; @@ -88,6 +95,10 @@ QModelingElement *QUmlCollaborationUse::clone() const /*! A mapping between features of the collaboration type and features of the owning classifier. This mapping indicates which connectable element of the classifier plays which role(s) in the collaboration. A connectable element may be bound to multiple roles in the same collaboration use (that is, it may play multiple roles). + + \sa addRoleBinding(), removeRoleBinding() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlDependency *> QUmlCollaborationUse::roleBindings() const { @@ -96,6 +107,11 @@ const QSet<QUmlDependency *> QUmlCollaborationUse::roleBindings() const return _roleBindings; } +/*! + Adds \a roleBinding to roleBindings. + + \sa roleBindings(), removeRoleBinding() + */ void QUmlCollaborationUse::addRoleBinding(QUmlDependency *roleBinding) { // This is a read-write association end @@ -111,6 +127,11 @@ void QUmlCollaborationUse::addRoleBinding(QUmlDependency *roleBinding) } } +/*! + Removes \a roleBinding from roleBindings. + + \sa roleBindings(), addRoleBinding() + */ void QUmlCollaborationUse::removeRoleBinding(QUmlDependency *roleBinding) { // This is a read-write association end @@ -135,6 +156,9 @@ QUmlCollaboration *QUmlCollaborationUse::type() const return _type; } +/*! + Adjusts type to \a type. + */ void QUmlCollaborationUse::setType(QUmlCollaboration *type) { // This is a read-write association end diff --git a/src/uml/qumlcollaborationuse.h b/src/uml/qumlcollaborationuse.h index 42577066..2ab77d98 100644 --- a/src/uml/qumlcollaborationuse.h +++ b/src/uml/qumlcollaborationuse.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -77,7 +75,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCollaborationUse) *) -QT_END_HEADER - #endif // QUMLCOLLABORATIONUSE_H diff --git a/src/uml/qumlcombinedfragment.cpp b/src/uml/qumlcombinedfragment.cpp index 0d73cf04..4cbcffda 100644 --- a/src/uml/qumlcombinedfragment.cpp +++ b/src/uml/qumlcombinedfragment.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief A combined fragment defines an expression of interaction fragments. A combined fragment is defined by an interaction operator and corresponding interaction operands. Through the use of combined fragments the user will be able to describe a number of traces in a compact and concise manner. */ + +/*! + Creates a new QUmlCombinedFragment. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlCombinedFragment::QUmlCombinedFragment(bool createQModelingObject) : _interactionOperator(QtUml::InteractionOperatorKindSeq) { @@ -71,6 +75,9 @@ QUmlCombinedFragment::QUmlCombinedFragment(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCombinedFragmentObject(this)); } +/*! + Returns a deep-copied clone of the QUmlCombinedFragment. +*/ QModelingElement *QUmlCombinedFragment::clone() const { QUmlCombinedFragment *c = new QUmlCombinedFragment; @@ -102,6 +109,10 @@ QModelingElement *QUmlCombinedFragment::clone() const /*! Specifies the gates that form the interface between this CombinedFragment and its surroundings + + \sa addCfragmentGate(), removeCfragmentGate() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlGate *> QUmlCombinedFragment::cfragmentGates() const { @@ -110,6 +121,11 @@ const QSet<QUmlGate *> QUmlCombinedFragment::cfragmentGates() const return _cfragmentGates; } +/*! + Adds \a cfragmentGate to cfragmentGates. + + \sa cfragmentGates(), removeCfragmentGate() + */ void QUmlCombinedFragment::addCfragmentGate(QUmlGate *cfragmentGate) { // This is a read-write association end @@ -125,6 +141,11 @@ void QUmlCombinedFragment::addCfragmentGate(QUmlGate *cfragmentGate) } } +/*! + Removes \a cfragmentGate from cfragmentGates. + + \sa cfragmentGates(), addCfragmentGate() + */ void QUmlCombinedFragment::removeCfragmentGate(QUmlGate *cfragmentGate) { // This is a read-write association end @@ -149,6 +170,9 @@ QtUml::InteractionOperatorKind QUmlCombinedFragment::interactionOperator() const return _interactionOperator; } +/*! + Adjusts interactionOperator to \a interactionOperator. + */ void QUmlCombinedFragment::setInteractionOperator(QtUml::InteractionOperatorKind interactionOperator) { // This is a read-write property @@ -161,6 +185,10 @@ void QUmlCombinedFragment::setInteractionOperator(QtUml::InteractionOperatorKind /*! The set of operands of the combined fragment. + + \sa addOperand(), removeOperand() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QList<QUmlInteractionOperand *> QUmlCombinedFragment::operands() const { @@ -169,6 +197,11 @@ const QList<QUmlInteractionOperand *> QUmlCombinedFragment::operands() const return _operands; } +/*! + Adds \a operand to operands. + + \sa operands(), removeOperand() + */ void QUmlCombinedFragment::addOperand(QUmlInteractionOperand *operand) { // This is a read-write association end @@ -184,6 +217,11 @@ void QUmlCombinedFragment::addOperand(QUmlInteractionOperand *operand) } } +/*! + Removes \a operand from operands. + + \sa operands(), addOperand() + */ void QUmlCombinedFragment::removeOperand(QUmlInteractionOperand *operand) { // This is a read-write association end diff --git a/src/uml/qumlcombinedfragment.h b/src/uml/qumlcombinedfragment.h index 7c30343d..ebcf5612 100644 --- a/src/uml/qumlcombinedfragment.h +++ b/src/uml/qumlcombinedfragment.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -83,7 +81,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCombinedFragment) *) -QT_END_HEADER - #endif // QUMLCOMBINEDFRAGMENT_H diff --git a/src/uml/qumlcomment.cpp b/src/uml/qumlcomment.cpp index 75512df7..b7ac6f33 100644 --- a/src/uml/qumlcomment.cpp +++ b/src/uml/qumlcomment.cpp @@ -51,12 +51,19 @@ QT_BEGIN_NAMESPACE \brief A comment is a textual annotation that can be attached to a set of elements. */ + +/*! + Creates a new QUmlComment. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlComment::QUmlComment(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCommentObject(this)); } +/*! + Returns a deep-copied clone of the QUmlComment. +*/ QModelingElement *QUmlComment::clone() const { QUmlComment *c = new QUmlComment; @@ -72,6 +79,8 @@ QModelingElement *QUmlComment::clone() const /*! References the Element(s) being commented. + + \sa addAnnotatedElement(), removeAnnotatedElement() */ const QSet<QUmlElement *> QUmlComment::annotatedElements() const { @@ -80,6 +89,11 @@ const QSet<QUmlElement *> QUmlComment::annotatedElements() const return _annotatedElements; } +/*! + Adds \a annotatedElement to annotatedElements. + + \sa annotatedElements(), removeAnnotatedElement() + */ void QUmlComment::addAnnotatedElement(QUmlElement *annotatedElement) { // This is a read-write association end @@ -91,6 +105,11 @@ void QUmlComment::addAnnotatedElement(QUmlElement *annotatedElement) } } +/*! + Removes \a annotatedElement from annotatedElements. + + \sa annotatedElements(), addAnnotatedElement() + */ void QUmlComment::removeAnnotatedElement(QUmlElement *annotatedElement) { // This is a read-write association end @@ -110,6 +129,9 @@ QString QUmlComment::body() const return _body; } +/*! + Adjusts body to \a body. + */ void QUmlComment::setBody(QString body) { // This is a read-write property diff --git a/src/uml/qumlcomment.h b/src/uml/qumlcomment.h index 75c849de..55b6411d 100644 --- a/src/uml/qumlcomment.h +++ b/src/uml/qumlcomment.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -74,7 +72,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlComment) *) -QT_END_HEADER - #endif // QUMLCOMMENT_H diff --git a/src/uml/qumlcommunicationpath.cpp b/src/uml/qumlcommunicationpath.cpp index 7f7196ec..0cf45a98 100644 --- a/src/uml/qumlcommunicationpath.cpp +++ b/src/uml/qumlcommunicationpath.cpp @@ -79,6 +79,10 @@ QT_BEGIN_NAMESPACE \brief A communication path is an association between two deployment targets, through which they are able to exchange signals and messages. */ + +/*! + Creates a new QUmlCommunicationPath. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlCommunicationPath::QUmlCommunicationPath(bool createQModelingObject) : QUmlAssociation(false) { @@ -86,6 +90,9 @@ QUmlCommunicationPath::QUmlCommunicationPath(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCommunicationPathObject(this)); } +/*! + Returns a deep-copied clone of the QUmlCommunicationPath. +*/ QModelingElement *QUmlCommunicationPath::clone() const { QUmlCommunicationPath *c = new QUmlCommunicationPath; diff --git a/src/uml/qumlcommunicationpath.h b/src/uml/qumlcommunicationpath.h index 5ba56f1e..58e816c4 100644 --- a/src/uml/qumlcommunicationpath.h +++ b/src/uml/qumlcommunicationpath.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAssociation> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCommunicationPath) *) -QT_END_HEADER - #endif // QUMLCOMMUNICATIONPATH_H diff --git a/src/uml/qumlcomponent.cpp b/src/uml/qumlcomponent.cpp index c6db3add..b153a807 100644 --- a/src/uml/qumlcomponent.cpp +++ b/src/uml/qumlcomponent.cpp @@ -89,6 +89,10 @@ QT_BEGIN_NAMESPACE \brief In the namespace of a component, all model elements that are involved in or related to its definition are either owned or imported explicitly. This may include, for example, use cases and dependencies (e.g. mappings), packages, components, and artifacts.A component represents a modular part of a system that encapsulates its contents and whose manifestation is replaceable within its environment. */ + +/*! + Creates a new QUmlComponent. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlComponent::QUmlComponent(bool createQModelingObject) : QUmlClass(false), _isIndirectlyInstantiated(true) @@ -97,6 +101,9 @@ QUmlComponent::QUmlComponent(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlComponentObject(this)); } +/*! + Returns a deep-copied clone of the QUmlComponent. +*/ QModelingElement *QUmlComponent::clone() const { QUmlComponent *c = new QUmlComponent; @@ -180,6 +187,9 @@ bool QUmlComponent::isIndirectlyInstantiated() const return _isIndirectlyInstantiated; } +/*! + Adjusts isIndirectlyInstantiated to \a isIndirectlyInstantiated. + */ void QUmlComponent::setIndirectlyInstantiated(bool isIndirectlyInstantiated) { // This is a read-write property @@ -192,6 +202,10 @@ void QUmlComponent::setIndirectlyInstantiated(bool isIndirectlyInstantiated) /*! The set of PackageableElements that a Component owns. In the namespace of a component, all model elements that are involved in or related to its definition may be owned or imported explicitly. These may include e.g. Classes, Interfaces, Components, Packages, Use cases, Dependencies (e.g. mappings), and Artifacts. + + \sa addPackagedElement(), removePackagedElement() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QSet<QUmlPackageableElement *> QUmlComponent::packagedElements() const { @@ -200,6 +214,11 @@ const QSet<QUmlPackageableElement *> QUmlComponent::packagedElements() const return _packagedElements; } +/*! + Adds \a packagedElement to packagedElements. + + \sa packagedElements(), removePackagedElement() + */ void QUmlComponent::addPackagedElement(QUmlPackageableElement *packagedElement) { // This is a read-write association end @@ -215,6 +234,11 @@ void QUmlComponent::addPackagedElement(QUmlPackageableElement *packagedElement) } } +/*! + Removes \a packagedElement from packagedElements. + + \sa packagedElements(), addPackagedElement() + */ void QUmlComponent::removePackagedElement(QUmlPackageableElement *packagedElement) { // This is a read-write association end @@ -231,6 +255,8 @@ void QUmlComponent::removePackagedElement(QUmlPackageableElement *packagedElemen /*! The interfaces that the component exposes to its environment. These interfaces may be Realized by the Component or any of its realizingClassifiers, or they may be the Interfaces that are provided by its public Ports. + + \b {This is a read-only derived property.} */ const QSet<QUmlInterface *> QUmlComponent::provided() const { @@ -241,6 +267,11 @@ const QSet<QUmlInterface *> QUmlComponent::provided() const return QSet<QUmlInterface *>(); } +/*! + Adds \a provided to provided. + + \sa provided(), removeProvided() + */ void QUmlComponent::addProvided(QUmlInterface *provided) { // This is a read-only derived association end @@ -253,6 +284,11 @@ void QUmlComponent::addProvided(QUmlInterface *provided) } } +/*! + Removes \a provided from provided. + + \sa provided(), addProvided() + */ void QUmlComponent::removeProvided(QUmlInterface *provided) { // This is a read-only derived association end @@ -267,6 +303,12 @@ void QUmlComponent::removeProvided(QUmlInterface *provided) /*! The set of Realizations owned by the Component. Realizations reference the Classifiers of which the Component is an abstraction; i.e., that realize its behavior. + + \sa addRealization(), removeRealization() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlComponentRealization::abstraction(). */ const QSet<QUmlComponentRealization *> QUmlComponent::realizations() const { @@ -275,6 +317,11 @@ const QSet<QUmlComponentRealization *> QUmlComponent::realizations() const return _realizations; } +/*! + Adds \a realization to realizations. + + \sa realizations(), removeRealization() + */ void QUmlComponent::addRealization(QUmlComponentRealization *realization) { // This is a read-write association end @@ -295,6 +342,11 @@ void QUmlComponent::addRealization(QUmlComponentRealization *realization) } } +/*! + Removes \a realization from realizations. + + \sa realizations(), addRealization() + */ void QUmlComponent::removeRealization(QUmlComponentRealization *realization) { // This is a read-write association end @@ -316,6 +368,8 @@ void QUmlComponent::removeRealization(QUmlComponentRealization *realization) /*! The interfaces that the component requires from other components in its environment in order to be able to offer its full set of provided functionality. These interfaces may be used by the Component or any of its realizingClassifiers, or they may be the Interfaces that are required by its public Ports. + + \b {This is a read-only derived property.} */ const QSet<QUmlInterface *> QUmlComponent::required() const { @@ -326,6 +380,11 @@ const QSet<QUmlInterface *> QUmlComponent::required() const return QSet<QUmlInterface *>(); } +/*! + Adds \a required to required. + + \sa required(), removeRequired() + */ void QUmlComponent::addRequired(QUmlInterface *required) { // This is a read-only derived association end @@ -338,6 +397,11 @@ void QUmlComponent::addRequired(QUmlInterface *required) } } +/*! + Removes \a required from required. + + \sa required(), addRequired() + */ void QUmlComponent::removeRequired(QUmlInterface *required) { // This is a read-only derived association end diff --git a/src/uml/qumlcomponent.h b/src/uml/qumlcomponent.h index be107c62..0f6e928e 100644 --- a/src/uml/qumlcomponent.h +++ b/src/uml/qumlcomponent.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlClass> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -93,7 +91,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlComponent) *) -QT_END_HEADER - #endif // QUMLCOMPONENT_H diff --git a/src/uml/qumlcomponentrealization.cpp b/src/uml/qumlcomponentrealization.cpp index c41e2922..027fb356 100644 --- a/src/uml/qumlcomponentrealization.cpp +++ b/src/uml/qumlcomponentrealization.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief The realization concept is specialized to (optionally) define the classifiers that realize the contract offered by a component in terms of its provided and required interfaces. The component forms an abstraction from these various classifiers. */ + +/*! + Creates a new QUmlComponentRealization. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlComponentRealization::QUmlComponentRealization(bool createQModelingObject) : QUmlRealization(false), _abstraction(0) @@ -72,6 +76,9 @@ QUmlComponentRealization::QUmlComponentRealization(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlComponentRealizationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlComponentRealization. +*/ QModelingElement *QUmlComponentRealization::clone() const { QUmlComponentRealization *c = new QUmlComponentRealization; @@ -104,6 +111,10 @@ QModelingElement *QUmlComponentRealization::clone() const /*! The Component that owns this ComponentRealization and which is implemented by its realizing classifiers. + + \b {Subsetted property(ies):} QUmlDependency::suppliers(), QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlComponent::realizations(). */ QUmlComponent *QUmlComponentRealization::abstraction() const { @@ -112,6 +123,9 @@ QUmlComponent *QUmlComponentRealization::abstraction() const return _abstraction; } +/*! + Adjusts abstraction to \a abstraction. + */ void QUmlComponentRealization::setAbstraction(QUmlComponent *abstraction) { // This is a read-write association end @@ -134,6 +148,10 @@ void QUmlComponentRealization::setAbstraction(QUmlComponent *abstraction) /*! The classifiers that are involved in the implementation of the Component that owns this Realization. + + \sa addRealizingClassifier(), removeRealizingClassifier() + + \b {Subsetted property(ies):} QUmlDependency::clients(). */ const QSet<QUmlClassifier *> QUmlComponentRealization::realizingClassifiers() const { @@ -142,6 +160,11 @@ const QSet<QUmlClassifier *> QUmlComponentRealization::realizingClassifiers() co return _realizingClassifiers; } +/*! + Adds \a realizingClassifier to realizingClassifiers. + + \sa realizingClassifiers(), removeRealizingClassifier() + */ void QUmlComponentRealization::addRealizingClassifier(QUmlClassifier *realizingClassifier) { // This is a read-write association end @@ -156,6 +179,11 @@ void QUmlComponentRealization::addRealizingClassifier(QUmlClassifier *realizingC } } +/*! + Removes \a realizingClassifier from realizingClassifiers. + + \sa realizingClassifiers(), addRealizingClassifier() + */ void QUmlComponentRealization::removeRealizingClassifier(QUmlClassifier *realizingClassifier) { // This is a read-write association end diff --git a/src/uml/qumlcomponentrealization.h b/src/uml/qumlcomponentrealization.h index 00e827cf..b624c74b 100644 --- a/src/uml/qumlcomponentrealization.h +++ b/src/uml/qumlcomponentrealization.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlRealization> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -77,7 +75,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlComponentRealization) *) -QT_END_HEADER - #endif // QUMLCOMPONENTREALIZATION_H diff --git a/src/uml/qumlconditionalnode.cpp b/src/uml/qumlconditionalnode.cpp index bacdf7d8..eaaaeac0 100644 --- a/src/uml/qumlconditionalnode.cpp +++ b/src/uml/qumlconditionalnode.cpp @@ -76,6 +76,10 @@ QT_BEGIN_NAMESPACE \brief A conditional node is a structured activity node that represents an exclusive choice among some number of alternatives. */ + +/*! + Creates a new QUmlConditionalNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlConditionalNode::QUmlConditionalNode(bool createQModelingObject) : QUmlStructuredActivityNode(false), _isAssured(false), @@ -85,6 +89,9 @@ QUmlConditionalNode::QUmlConditionalNode(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlConditionalNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlConditionalNode. +*/ QModelingElement *QUmlConditionalNode::clone() const { QUmlConditionalNode *c = new QUmlConditionalNode; @@ -146,6 +153,10 @@ QModelingElement *QUmlConditionalNode::clone() const /*! Set of clauses composing the conditional. + + \sa addClause(), removeClause() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlClause *> QUmlConditionalNode::clauses() const { @@ -154,6 +165,11 @@ const QSet<QUmlClause *> QUmlConditionalNode::clauses() const return _clauses; } +/*! + Adds \a clause to clauses. + + \sa clauses(), removeClause() + */ void QUmlConditionalNode::addClause(QUmlClause *clause) { // This is a read-write association end @@ -169,6 +185,11 @@ void QUmlConditionalNode::addClause(QUmlClause *clause) } } +/*! + Removes \a clause from clauses. + + \sa clauses(), addClause() + */ void QUmlConditionalNode::removeClause(QUmlClause *clause) { // This is a read-write association end @@ -193,6 +214,9 @@ bool QUmlConditionalNode::isAssured() const return _isAssured; } +/*! + Adjusts isAssured to \a isAssured. + */ void QUmlConditionalNode::setAssured(bool isAssured) { // This is a read-write property @@ -213,6 +237,9 @@ bool QUmlConditionalNode::isDeterminate() const return _isDeterminate; } +/*! + Adjusts isDeterminate to \a isDeterminate. + */ void QUmlConditionalNode::setDeterminate(bool isDeterminate) { // This is a read-write property @@ -225,6 +252,10 @@ void QUmlConditionalNode::setDeterminate(bool isDeterminate) /*! A list of output pins that constitute the data flow outputs of the conditional. + + \sa addResult(), removeResult() + + \b {Redefined property(ies):} QUmlStructuredActivityNode::structuredNodeOutputs(). */ const QList<QUmlOutputPin *> QUmlConditionalNode::results() const { @@ -233,6 +264,11 @@ const QList<QUmlOutputPin *> QUmlConditionalNode::results() const return _results; } +/*! + Adds \a result to results. + + \sa results(), removeResult() + */ void QUmlConditionalNode::addResult(QUmlOutputPin *result) { // This is a read-write association end @@ -248,6 +284,11 @@ void QUmlConditionalNode::addResult(QUmlOutputPin *result) } } +/*! + Removes \a result from results. + + \sa results(), addResult() + */ void QUmlConditionalNode::removeResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlconditionalnode.h b/src/uml/qumlconditionalnode.h index 5ba6939b..3418159c 100644 --- a/src/uml/qumlconditionalnode.h +++ b/src/uml/qumlconditionalnode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlStructuredActivityNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -84,7 +82,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlConditionalNode) *) -QT_END_HEADER - #endif // QUMLCONDITIONALNODE_H diff --git a/src/uml/qumlconnectableelement.cpp b/src/uml/qumlconnectableelement.cpp index 65c60b7f..dbae0a49 100644 --- a/src/uml/qumlconnectableelement.cpp +++ b/src/uml/qumlconnectableelement.cpp @@ -60,12 +60,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief ConnectableElement is an abstract metaclass representing a set of instances that play roles of a classifier. Connectable elements may be joined by attached connectors and specify configurations of linked instances to be created within an instance of the containing classifier.A connectable element may be exposed as a connectable element template parameter. + + \b {QUmlConnectableElement is an abstract class.} */ + +/*! + Creates a new QUmlConnectableElement. +*/ QUmlConnectableElement::QUmlConnectableElement() : _templateParameter(0) { } +/*! + Returns a deep-copied clone of the QUmlConnectableElement. +*/ QModelingElement *QUmlConnectableElement::clone() const { QUmlConnectableElement *c = new QUmlConnectableElement; @@ -90,6 +99,10 @@ QModelingElement *QUmlConnectableElement::clone() const /*! Denotes a set of connector ends that attaches to this connectable element. + + \b {This is a read-only derived property.} + + \b {Opposite property(ies):} QUmlConnectorEnd::role(). */ const QList<QUmlConnectorEnd *> QUmlConnectableElement::ends() const { @@ -100,6 +113,11 @@ const QList<QUmlConnectorEnd *> QUmlConnectableElement::ends() const return QList<QUmlConnectorEnd *>(); } +/*! + Adds \a end to ends. + + \sa ends(), removeEnd() + */ void QUmlConnectableElement::addEnd(QUmlConnectorEnd *end) { // This is a read-only derived association end @@ -117,6 +135,11 @@ void QUmlConnectableElement::addEnd(QUmlConnectorEnd *end) } } +/*! + Removes \a end from ends. + + \sa ends(), addEnd() + */ void QUmlConnectableElement::removeEnd(QUmlConnectorEnd *end) { // This is a read-only derived association end @@ -136,6 +159,10 @@ void QUmlConnectableElement::removeEnd(QUmlConnectorEnd *end) /*! The ConnectableElementTemplateParameter for this ConnectableElement parameter. + + \b {Redefined property(ies):} QUmlParameterableElement::templateParameter(). + + \b {Opposite property(ies):} QUmlConnectableElementTemplateParameter::parameteredElement(). */ QUmlConnectableElementTemplateParameter *QUmlConnectableElement::templateParameter() const { @@ -144,6 +171,9 @@ QUmlConnectableElementTemplateParameter *QUmlConnectableElement::templateParamet return _templateParameter; } +/*! + Adjusts templateParameter to \a templateParameter. + */ void QUmlConnectableElement::setTemplateParameter(QUmlConnectableElementTemplateParameter *templateParameter) { // This is a read-write association end diff --git a/src/uml/qumlconnectableelement.h b/src/uml/qumlconnectableelement.h index 3965254a..f0218382 100644 --- a/src/uml/qumlconnectableelement.h +++ b/src/uml/qumlconnectableelement.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlTypedElement> #include <QtUml/QUmlParameterableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -77,7 +75,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlConnectableElement) *) -QT_END_HEADER - #endif // QUMLCONNECTABLEELEMENT_H diff --git a/src/uml/qumlconnectableelementtemplateparameter.cpp b/src/uml/qumlconnectableelementtemplateparameter.cpp index d8d707eb..66641693 100644 --- a/src/uml/qumlconnectableelementtemplateparameter.cpp +++ b/src/uml/qumlconnectableelementtemplateparameter.cpp @@ -57,6 +57,10 @@ QT_BEGIN_NAMESPACE \brief A connectable element template parameter exposes a connectable element as a formal parameter for a template. */ + +/*! + Creates a new QUmlConnectableElementTemplateParameter. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlConnectableElementTemplateParameter::QUmlConnectableElementTemplateParameter(bool createQModelingObject) : QUmlTemplateParameter(false), _parameteredElement(0) @@ -65,6 +69,9 @@ QUmlConnectableElementTemplateParameter::QUmlConnectableElementTemplateParameter _qModelingObject = qobject_cast<QModelingObject *>(new QUmlConnectableElementTemplateParameterObject(this)); } +/*! + Returns a deep-copied clone of the QUmlConnectableElementTemplateParameter. +*/ QModelingElement *QUmlConnectableElementTemplateParameter::clone() const { QUmlConnectableElementTemplateParameter *c = new QUmlConnectableElementTemplateParameter; @@ -87,6 +94,10 @@ QModelingElement *QUmlConnectableElementTemplateParameter::clone() const /*! The ConnectableElement for this template parameter. + + \b {Redefined property(ies):} QUmlTemplateParameter::parameteredElement(). + + \b {Opposite property(ies):} QUmlConnectableElement::templateParameter(). */ QUmlConnectableElement *QUmlConnectableElementTemplateParameter::parameteredElement() const { @@ -95,6 +106,9 @@ QUmlConnectableElement *QUmlConnectableElementTemplateParameter::parameteredElem return _parameteredElement; } +/*! + Adjusts parameteredElement to \a parameteredElement. + */ void QUmlConnectableElementTemplateParameter::setParameteredElement(QUmlConnectableElement *parameteredElement) { // This is a read-write association end diff --git a/src/uml/qumlconnectableelementtemplateparameter.h b/src/uml/qumlconnectableelementtemplateparameter.h index 3d3a4540..4df3cea2 100644 --- a/src/uml/qumlconnectableelementtemplateparameter.h +++ b/src/uml/qumlconnectableelementtemplateparameter.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlTemplateParameter> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlConnectableElementTemplateParameter) *) -QT_END_HEADER - #endif // QUMLCONNECTABLEELEMENTTEMPLATEPARAMETER_H diff --git a/src/uml/qumlconnectionpointreference.cpp b/src/uml/qumlconnectionpointreference.cpp index 491a4138..f017fe6d 100644 --- a/src/uml/qumlconnectionpointreference.cpp +++ b/src/uml/qumlconnectionpointreference.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief A connection point reference represents a usage (as part of a submachine state) of an entry/exit point defined in the statemachine reference by the submachine state. */ + +/*! + Creates a new QUmlConnectionPointReference. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlConnectionPointReference::QUmlConnectionPointReference(bool createQModelingObject) : _state(0) { @@ -71,6 +75,9 @@ QUmlConnectionPointReference::QUmlConnectionPointReference(bool createQModelingO _qModelingObject = qobject_cast<QModelingObject *>(new QUmlConnectionPointReferenceObject(this)); } +/*! + Returns a deep-copied clone of the QUmlConnectionPointReference. +*/ QModelingElement *QUmlConnectionPointReference::clone() const { QUmlConnectionPointReference *c = new QUmlConnectionPointReference; @@ -97,6 +104,8 @@ QModelingElement *QUmlConnectionPointReference::clone() const /*! The entryPoint kind pseudo states corresponding to this connection point. + + \sa addEntry(), removeEntry() */ const QSet<QUmlPseudostate *> QUmlConnectionPointReference::entries() const { @@ -105,6 +114,11 @@ const QSet<QUmlPseudostate *> QUmlConnectionPointReference::entries() const return _entries; } +/*! + Adds \a entry to entries. + + \sa entries(), removeEntry() + */ void QUmlConnectionPointReference::addEntry(QUmlPseudostate *entry) { // This is a read-write association end @@ -116,6 +130,11 @@ void QUmlConnectionPointReference::addEntry(QUmlPseudostate *entry) } } +/*! + Removes \a entry from entries. + + \sa entries(), addEntry() + */ void QUmlConnectionPointReference::removeEntry(QUmlPseudostate *entry) { // This is a read-write association end @@ -127,6 +146,8 @@ void QUmlConnectionPointReference::removeEntry(QUmlPseudostate *entry) /*! The exitPoints kind pseudo states corresponding to this connection point. + + \sa addExit(), removeExit() */ const QSet<QUmlPseudostate *> QUmlConnectionPointReference::exits() const { @@ -135,6 +156,11 @@ const QSet<QUmlPseudostate *> QUmlConnectionPointReference::exits() const return _exits; } +/*! + Adds \a exit to exits. + + \sa exits(), removeExit() + */ void QUmlConnectionPointReference::addExit(QUmlPseudostate *exit) { // This is a read-write association end @@ -146,6 +172,11 @@ void QUmlConnectionPointReference::addExit(QUmlPseudostate *exit) } } +/*! + Removes \a exit from exits. + + \sa exits(), addExit() + */ void QUmlConnectionPointReference::removeExit(QUmlPseudostate *exit) { // This is a read-write association end @@ -157,6 +188,10 @@ void QUmlConnectionPointReference::removeExit(QUmlPseudostate *exit) /*! The State in which the connection point refreshens are defined. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlState::connections(). */ QUmlState *QUmlConnectionPointReference::state() const { @@ -165,6 +200,9 @@ QUmlState *QUmlConnectionPointReference::state() const return _state; } +/*! + Adjusts state to \a state. + */ void QUmlConnectionPointReference::setState(QUmlState *state) { // This is a read-write association end diff --git a/src/uml/qumlconnectionpointreference.h b/src/uml/qumlconnectionpointreference.h index f17463d6..dd945259 100644 --- a/src/uml/qumlconnectionpointreference.h +++ b/src/uml/qumlconnectionpointreference.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlVertex> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlConnectionPointReference) *) -QT_END_HEADER - #endif // QUMLCONNECTIONPOINTREFERENCE_H diff --git a/src/uml/qumlconnector.cpp b/src/uml/qumlconnector.cpp index 9f1e8361..46afe498 100644 --- a/src/uml/qumlconnector.cpp +++ b/src/uml/qumlconnector.cpp @@ -66,6 +66,10 @@ QT_BEGIN_NAMESPACE \brief A delegation connector is a connector that links the external contract of a component (as specified by its ports) to the realization of that behavior. It represents the forwarding of events (operation requests and events): a signal that arrives at a port that has a delegation connector to one or more parts or ports on parts will be passed on to those targets for handling. An assembly connector is a connector between two or more parts or ports on parts that defines that one or more parts provide the services that other parts use.Specifies a link that enables communication between two or more instances. This link may be an instance of an association, or it may represent the possibility of the instances being able to communicate because their identities are known by virtue of being passed in as parameters, held in variables or slots, or because the communicating instances are the same instance. The link may be realized by something as simple as a pointer or by something as complex as a network connection. In contrast to associations, which specify links between any instance of the associated classifiers, connectors specify links between instances playing the connected parts only. */ + +/*! + Creates a new QUmlConnector. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlConnector::QUmlConnector(bool createQModelingObject) : _type(0) { @@ -73,6 +77,9 @@ QUmlConnector::QUmlConnector(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlConnectorObject(this)); } +/*! + Returns a deep-copied clone of the QUmlConnector. +*/ QModelingElement *QUmlConnector::clone() const { QUmlConnector *c = new QUmlConnector; @@ -101,6 +108,8 @@ QModelingElement *QUmlConnector::clone() const /*! The set of Behaviors that specify the valid interaction patterns across the connector. + + \sa addContract(), removeContract() */ const QSet<QUmlBehavior *> QUmlConnector::contracts() const { @@ -109,6 +118,11 @@ const QSet<QUmlBehavior *> QUmlConnector::contracts() const return _contracts; } +/*! + Adds \a contract to contracts. + + \sa contracts(), removeContract() + */ void QUmlConnector::addContract(QUmlBehavior *contract) { // This is a read-write association end @@ -120,6 +134,11 @@ void QUmlConnector::addContract(QUmlBehavior *contract) } } +/*! + Removes \a contract from contracts. + + \sa contracts(), addContract() + */ void QUmlConnector::removeContract(QUmlBehavior *contract) { // This is a read-write association end @@ -131,6 +150,10 @@ void QUmlConnector::removeContract(QUmlBehavior *contract) /*! A connector consists of at least two connector ends, each representing the participation of instances of the classifiers typing the connectable elements attached to this end. The set of connector ends is ordered. + + \sa addEnd(), removeEnd() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QList<QUmlConnectorEnd *> QUmlConnector::ends() const { @@ -139,6 +162,11 @@ const QList<QUmlConnectorEnd *> QUmlConnector::ends() const return _ends; } +/*! + Adds \a end to ends. + + \sa ends(), removeEnd() + */ void QUmlConnector::addEnd(QUmlConnectorEnd *end) { // This is a read-write association end @@ -154,6 +182,11 @@ void QUmlConnector::addEnd(QUmlConnectorEnd *end) } } +/*! + Removes \a end from ends. + + \sa ends(), addEnd() + */ void QUmlConnector::removeEnd(QUmlConnectorEnd *end) { // This is a read-write association end @@ -170,6 +203,8 @@ void QUmlConnector::removeEnd(QUmlConnectorEnd *end) /*! Indicates the kind of connector. This is derived: a connector with one or more ends connected to a Port which is not on a Part and which is not a behavior port is a delegation; otherwise it is an assembly. + + \b {This is a read-only derived property.} */ QtUml::ConnectorKind QUmlConnector::kind() const { @@ -182,6 +217,9 @@ QtUml::ConnectorKind QUmlConnector::kind() const return found ? QtUml::ConnectorKindDelegation:QtUml::ConnectorKindAssembly; } +/*! + Adjusts kind to \a kind. + */ void QUmlConnector::setKind(QtUml::ConnectorKind kind) { // This is a read-only derived property @@ -196,6 +234,10 @@ void QUmlConnector::setKind(QtUml::ConnectorKind kind) /*! A connector may be redefined when its containing classifier is specialized. The redefining connector may have a type that specializes the type of the redefined connector. The types of the connector ends of the redefining connector may specialize the types of the connector ends of the redefined connector. The properties of the connector ends of the redefining connector may be replaced. + + \sa addRedefinedConnector(), removeRedefinedConnector() + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinedElements(). */ const QSet<QUmlConnector *> QUmlConnector::redefinedConnectors() const { @@ -204,6 +246,11 @@ const QSet<QUmlConnector *> QUmlConnector::redefinedConnectors() const return _redefinedConnectors; } +/*! + Adds \a redefinedConnector to redefinedConnectors. + + \sa redefinedConnectors(), removeRedefinedConnector() + */ void QUmlConnector::addRedefinedConnector(QUmlConnector *redefinedConnector) { // This is a read-write association end @@ -218,6 +265,11 @@ void QUmlConnector::addRedefinedConnector(QUmlConnector *redefinedConnector) } } +/*! + Removes \a redefinedConnector from redefinedConnectors. + + \sa redefinedConnectors(), addRedefinedConnector() + */ void QUmlConnector::removeRedefinedConnector(QUmlConnector *redefinedConnector) { // This is a read-write association end @@ -240,6 +292,9 @@ QUmlAssociation *QUmlConnector::type() const return _type; } +/*! + Adjusts type to \a type. + */ void QUmlConnector::setType(QUmlAssociation *type) { // This is a read-write association end diff --git a/src/uml/qumlconnector.h b/src/uml/qumlconnector.h index 9af30042..949d1596 100644 --- a/src/uml/qumlconnector.h +++ b/src/uml/qumlconnector.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -90,7 +88,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlConnector) *) -QT_END_HEADER - #endif // QUMLCONNECTOR_H diff --git a/src/uml/qumlconnectorend.cpp b/src/uml/qumlconnectorend.cpp index af5e9263..ee969c97 100644 --- a/src/uml/qumlconnectorend.cpp +++ b/src/uml/qumlconnectorend.cpp @@ -57,6 +57,10 @@ QT_BEGIN_NAMESPACE \brief A connector end is an endpoint of a connector, which attaches the connector to a connectable element. Each connector end is part of one connector. */ + +/*! + Creates a new QUmlConnectorEnd. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlConnectorEnd::QUmlConnectorEnd(bool createQModelingObject) : _partWithPort(0), _role(0) @@ -65,6 +69,9 @@ QUmlConnectorEnd::QUmlConnectorEnd(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlConnectorEndObject(this)); } +/*! + Returns a deep-copied clone of the QUmlConnectorEnd. +*/ QModelingElement *QUmlConnectorEnd::clone() const { QUmlConnectorEnd *c = new QUmlConnectorEnd; @@ -87,6 +94,8 @@ QModelingElement *QUmlConnectorEnd::clone() const /*! A derived association referencing the corresponding association end on the association which types the connector owing this connector end. This association is derived by selecting the association end at the same place in the ordering of association ends as this connector end. + + \b {This is a read-only derived property.} */ QUmlProperty *QUmlConnectorEnd::definingEnd() const { @@ -97,6 +106,9 @@ QUmlProperty *QUmlConnectorEnd::definingEnd() const return 0; } +/*! + Adjusts definingEnd to \a definingEnd. + */ void QUmlConnectorEnd::setDefiningEnd(QUmlProperty *definingEnd) { // This is a read-only derived association end @@ -119,6 +131,9 @@ QUmlProperty *QUmlConnectorEnd::partWithPort() const return _partWithPort; } +/*! + Adjusts partWithPort to \a partWithPort. + */ void QUmlConnectorEnd::setPartWithPort(QUmlProperty *partWithPort) { // This is a read-write association end @@ -132,6 +147,8 @@ void QUmlConnectorEnd::setPartWithPort(QUmlProperty *partWithPort) /*! The connectable element attached at this connector end. When an instance of the containing classifier is created, a link may (depending on the multiplicities) be created to an instance of the classifier that types this connectable element. + + \b {Opposite property(ies):} QUmlConnectableElement::ends(). */ QUmlConnectableElement *QUmlConnectorEnd::role() const { @@ -140,6 +157,9 @@ QUmlConnectableElement *QUmlConnectorEnd::role() const return _role; } +/*! + Adjusts role to \a role. + */ void QUmlConnectorEnd::setRole(QUmlConnectableElement *role) { // This is a read-write association end diff --git a/src/uml/qumlconnectorend.h b/src/uml/qumlconnectorend.h index 66844565..33e9cf17 100644 --- a/src/uml/qumlconnectorend.h +++ b/src/uml/qumlconnectorend.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlMultiplicityElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -78,7 +76,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlConnectorEnd) *) -QT_END_HEADER - #endif // QUMLCONNECTOREND_H diff --git a/src/uml/qumlconsiderignorefragment.cpp b/src/uml/qumlconsiderignorefragment.cpp index d3195cb7..3b3b9fc1 100644 --- a/src/uml/qumlconsiderignorefragment.cpp +++ b/src/uml/qumlconsiderignorefragment.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief A consider ignore fragment is a kind of combined fragment that is used for the consider and ignore cases, which require lists of pertinent messages to be specified. */ + +/*! + Creates a new QUmlConsiderIgnoreFragment. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlConsiderIgnoreFragment::QUmlConsiderIgnoreFragment(bool createQModelingObject) : QUmlCombinedFragment(false) { @@ -71,6 +75,9 @@ QUmlConsiderIgnoreFragment::QUmlConsiderIgnoreFragment(bool createQModelingObjec _qModelingObject = qobject_cast<QModelingObject *>(new QUmlConsiderIgnoreFragmentObject(this)); } +/*! + Returns a deep-copied clone of the QUmlConsiderIgnoreFragment. +*/ QModelingElement *QUmlConsiderIgnoreFragment::clone() const { QUmlConsiderIgnoreFragment *c = new QUmlConsiderIgnoreFragment; @@ -104,6 +111,8 @@ QModelingElement *QUmlConsiderIgnoreFragment::clone() const /*! The set of messages that apply to this fragment + + \sa addMessage(), removeMessage() */ const QSet<QUmlNamedElement *> QUmlConsiderIgnoreFragment::messages() const { @@ -112,6 +121,11 @@ const QSet<QUmlNamedElement *> QUmlConsiderIgnoreFragment::messages() const return _messages; } +/*! + Adds \a message to messages. + + \sa messages(), removeMessage() + */ void QUmlConsiderIgnoreFragment::addMessage(QUmlNamedElement *message) { // This is a read-write association end @@ -123,6 +137,11 @@ void QUmlConsiderIgnoreFragment::addMessage(QUmlNamedElement *message) } } +/*! + Removes \a message from messages. + + \sa messages(), addMessage() + */ void QUmlConsiderIgnoreFragment::removeMessage(QUmlNamedElement *message) { // This is a read-write association end diff --git a/src/uml/qumlconsiderignorefragment.h b/src/uml/qumlconsiderignorefragment.h index 215e6348..7137d9ba 100644 --- a/src/uml/qumlconsiderignorefragment.h +++ b/src/uml/qumlconsiderignorefragment.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlCombinedFragment> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -73,7 +71,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlConsiderIgnoreFragment) *) -QT_END_HEADER - #endif // QUMLCONSIDERIGNOREFRAGMENT_H diff --git a/src/uml/qumlconstraint.cpp b/src/uml/qumlconstraint.cpp index 72fb3afa..78beab37 100644 --- a/src/uml/qumlconstraint.cpp +++ b/src/uml/qumlconstraint.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief A constraint is a condition or restriction expressed in natural language text or in a machine readable language for the purpose of declaring some of the semantics of an element. */ + +/*! + Creates a new QUmlConstraint. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlConstraint::QUmlConstraint(bool createQModelingObject) : _context(0), _specification(0) @@ -70,6 +74,9 @@ QUmlConstraint::QUmlConstraint(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlConstraintObject(this)); } +/*! + Returns a deep-copied clone of the QUmlConstraint. +*/ QModelingElement *QUmlConstraint::clone() const { QUmlConstraint *c = new QUmlConstraint; @@ -98,6 +105,8 @@ QModelingElement *QUmlConstraint::clone() const /*! The ordered set of Elements referenced by this Constraint. + + \sa addConstrainedElement(), removeConstrainedElement() */ const QList<QUmlElement *> QUmlConstraint::constrainedElements() const { @@ -106,6 +115,11 @@ const QList<QUmlElement *> QUmlConstraint::constrainedElements() const return _constrainedElements; } +/*! + Adds \a constrainedElement to constrainedElements. + + \sa constrainedElements(), removeConstrainedElement() + */ void QUmlConstraint::addConstrainedElement(QUmlElement *constrainedElement) { // This is a read-write association end @@ -117,6 +131,11 @@ void QUmlConstraint::addConstrainedElement(QUmlElement *constrainedElement) } } +/*! + Removes \a constrainedElement from constrainedElements. + + \sa constrainedElements(), addConstrainedElement() + */ void QUmlConstraint::removeConstrainedElement(QUmlElement *constrainedElement) { // This is a read-write association end @@ -128,6 +147,10 @@ void QUmlConstraint::removeConstrainedElement(QUmlElement *constrainedElement) /*! Specifies the namespace that owns the NamedElement. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlNamespace::ownedRules(). */ QUmlNamespace *QUmlConstraint::context() const { @@ -136,6 +159,9 @@ QUmlNamespace *QUmlConstraint::context() const return _context; } +/*! + Adjusts context to \a context. + */ void QUmlConstraint::setContext(QUmlNamespace *context) { // This is a read-write association end @@ -154,6 +180,8 @@ void QUmlConstraint::setContext(QUmlNamespace *context) /*! A condition that must be true when evaluated in order for the constraint to be satisfied. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlConstraint::specification() const { @@ -162,6 +190,9 @@ QUmlValueSpecification *QUmlConstraint::specification() const return _specification; } +/*! + Adjusts specification to \a specification. + */ void QUmlConstraint::setSpecification(QUmlValueSpecification *specification) { // This is a read-write association end diff --git a/src/uml/qumlconstraint.h b/src/uml/qumlconstraint.h index cc017005..2b227809 100644 --- a/src/uml/qumlconstraint.h +++ b/src/uml/qumlconstraint.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlPackageableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlConstraint) *) -QT_END_HEADER - #endif // QUMLCONSTRAINT_H diff --git a/src/uml/qumlcontinuation.cpp b/src/uml/qumlcontinuation.cpp index 70774da4..93a5237d 100644 --- a/src/uml/qumlcontinuation.cpp +++ b/src/uml/qumlcontinuation.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief A continuation is a syntactic way to define continuations of different branches of an alternative combined fragment. Continuations is intuitively similar to labels representing intermediate points in a flow of control. */ + +/*! + Creates a new QUmlContinuation. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlContinuation::QUmlContinuation(bool createQModelingObject) : _setting(true) { @@ -70,6 +74,9 @@ QUmlContinuation::QUmlContinuation(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlContinuationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlContinuation. +*/ QModelingElement *QUmlContinuation::clone() const { QUmlContinuation *c = new QUmlContinuation; @@ -105,6 +112,9 @@ bool QUmlContinuation::setting() const return _setting; } +/*! + Adjusts setting to \a setting. + */ void QUmlContinuation::setSetting(bool setting) { // This is a read-write property diff --git a/src/uml/qumlcontinuation.h b/src/uml/qumlcontinuation.h index e218c68b..a582fc46 100644 --- a/src/uml/qumlcontinuation.h +++ b/src/uml/qumlcontinuation.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInteractionFragment> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -70,7 +68,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlContinuation) *) -QT_END_HEADER - #endif // QUMLCONTINUATION_H diff --git a/src/uml/qumlcontrolflow.cpp b/src/uml/qumlcontrolflow.cpp index 3a724f96..e8eb2eeb 100644 --- a/src/uml/qumlcontrolflow.cpp +++ b/src/uml/qumlcontrolflow.cpp @@ -68,12 +68,19 @@ QT_BEGIN_NAMESPACE \brief A control flow is an edge that starts an activity node after the previous one is finished. */ + +/*! + Creates a new QUmlControlFlow. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlControlFlow::QUmlControlFlow(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlControlFlowObject(this)); } +/*! + Returns a deep-copied clone of the QUmlControlFlow. +*/ QModelingElement *QUmlControlFlow::clone() const { QUmlControlFlow *c = new QUmlControlFlow; diff --git a/src/uml/qumlcontrolflow.h b/src/uml/qumlcontrolflow.h index 972c1bea..f7eccb31 100644 --- a/src/uml/qumlcontrolflow.h +++ b/src/uml/qumlcontrolflow.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlActivityEdge> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlControlFlow) *) -QT_END_HEADER - #endif // QUMLCONTROLFLOW_H diff --git a/src/uml/qumlcontrolnode.cpp b/src/uml/qumlcontrolnode.cpp index b8f43931..9223f46e 100644 --- a/src/uml/qumlcontrolnode.cpp +++ b/src/uml/qumlcontrolnode.cpp @@ -64,11 +64,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A control node is an abstract activity node that coordinates flows in an activity. + + \b {QUmlControlNode is an abstract class.} */ + +/*! + Creates a new QUmlControlNode. +*/ QUmlControlNode::QUmlControlNode() { } +/*! + Returns a deep-copied clone of the QUmlControlNode. +*/ QModelingElement *QUmlControlNode::clone() const { QUmlControlNode *c = new QUmlControlNode; diff --git a/src/uml/qumlcontrolnode.h b/src/uml/qumlcontrolnode.h index 3261d2ce..22324d59 100644 --- a/src/uml/qumlcontrolnode.h +++ b/src/uml/qumlcontrolnode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlActivityNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlControlNode) *) -QT_END_HEADER - #endif // QUMLCONTROLNODE_H diff --git a/src/uml/qumlcreatelinkaction.cpp b/src/uml/qumlcreatelinkaction.cpp index 779fbd36..9fe71f2a 100644 --- a/src/uml/qumlcreatelinkaction.cpp +++ b/src/uml/qumlcreatelinkaction.cpp @@ -75,12 +75,19 @@ QT_BEGIN_NAMESPACE \brief A create link action is a write link action for creating links. */ + +/*! + Creates a new QUmlCreateLinkAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlCreateLinkAction::QUmlCreateLinkAction(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCreateLinkActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlCreateLinkAction. +*/ QModelingElement *QUmlCreateLinkAction::clone() const { QUmlCreateLinkAction *c = new QUmlCreateLinkAction; @@ -125,6 +132,10 @@ QModelingElement *QUmlCreateLinkAction::clone() const /*! Specifies ends of association and inputs. + + \sa addEndData(), removeEndData() + + \b {Redefined property(ies):} QUmlLinkAction::endData(). */ const QSet<QUmlLinkEndCreationData *> QUmlCreateLinkAction::endData() const { @@ -133,6 +144,11 @@ const QSet<QUmlLinkEndCreationData *> QUmlCreateLinkAction::endData() const return _endData; } +/*! + Adds \a endData to endData. + + \sa endData(), removeEndData() + */ void QUmlCreateLinkAction::addEndData(QUmlLinkEndCreationData *endData) { // This is a read-write association end @@ -148,6 +164,11 @@ void QUmlCreateLinkAction::addEndData(QUmlLinkEndCreationData *endData) } } +/*! + Removes \a endData from endData. + + \sa endData(), addEndData() + */ void QUmlCreateLinkAction::removeEndData(QUmlLinkEndCreationData *endData) { // This is a read-write association end diff --git a/src/uml/qumlcreatelinkaction.h b/src/uml/qumlcreatelinkaction.h index 2882140b..7571b39e 100644 --- a/src/uml/qumlcreatelinkaction.h +++ b/src/uml/qumlcreatelinkaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlWriteLinkAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -73,7 +71,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCreateLinkAction) *) -QT_END_HEADER - #endif // QUMLCREATELINKACTION_H diff --git a/src/uml/qumlcreatelinkobjectaction.cpp b/src/uml/qumlcreatelinkobjectaction.cpp index 72b60b30..dbdf3f71 100644 --- a/src/uml/qumlcreatelinkobjectaction.cpp +++ b/src/uml/qumlcreatelinkobjectaction.cpp @@ -75,6 +75,10 @@ QT_BEGIN_NAMESPACE \brief A create link object action creates a link object. */ + +/*! + Creates a new QUmlCreateLinkObjectAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlCreateLinkObjectAction::QUmlCreateLinkObjectAction(bool createQModelingObject) : QUmlCreateLinkAction(false), _result(0) @@ -83,6 +87,9 @@ QUmlCreateLinkObjectAction::QUmlCreateLinkObjectAction(bool createQModelingObjec _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCreateLinkObjectActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlCreateLinkObjectAction. +*/ QModelingElement *QUmlCreateLinkObjectAction::clone() const { QUmlCreateLinkObjectAction *c = new QUmlCreateLinkObjectAction; @@ -129,6 +136,8 @@ QModelingElement *QUmlCreateLinkObjectAction::clone() const /*! Gives the output pin on which the result is put. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlCreateLinkObjectAction::result() const { @@ -137,6 +146,9 @@ QUmlOutputPin *QUmlCreateLinkObjectAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlCreateLinkObjectAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlcreatelinkobjectaction.h b/src/uml/qumlcreatelinkobjectaction.h index dd3b8097..f5f23128 100644 --- a/src/uml/qumlcreatelinkobjectaction.h +++ b/src/uml/qumlcreatelinkobjectaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlCreateLinkAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCreateLinkObjectAction) *) -QT_END_HEADER - #endif // QUMLCREATELINKOBJECTACTION_H diff --git a/src/uml/qumlcreateobjectaction.cpp b/src/uml/qumlcreateobjectaction.cpp index e13bac58..3ca1525a 100644 --- a/src/uml/qumlcreateobjectaction.cpp +++ b/src/uml/qumlcreateobjectaction.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief A create object action is an action that creates an object that conforms to a statically specified classifier and puts it on an output pin at runtime. */ + +/*! + Creates a new QUmlCreateObjectAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlCreateObjectAction::QUmlCreateObjectAction(bool createQModelingObject) : _classifier(0), _result(0) @@ -80,6 +84,9 @@ QUmlCreateObjectAction::QUmlCreateObjectAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlCreateObjectActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlCreateObjectAction. +*/ QModelingElement *QUmlCreateObjectAction::clone() const { QUmlCreateObjectAction *c = new QUmlCreateObjectAction; @@ -132,6 +139,9 @@ QUmlClassifier *QUmlCreateObjectAction::classifier() const return _classifier; } +/*! + Adjusts classifier to \a classifier. + */ void QUmlCreateObjectAction::setClassifier(QUmlClassifier *classifier) { // This is a read-write association end @@ -145,6 +155,8 @@ void QUmlCreateObjectAction::setClassifier(QUmlClassifier *classifier) /*! Gives the output pin on which the result is put. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlCreateObjectAction::result() const { @@ -153,6 +165,9 @@ QUmlOutputPin *QUmlCreateObjectAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlCreateObjectAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlcreateobjectaction.h b/src/uml/qumlcreateobjectaction.h index 85f58acd..c6d5078c 100644 --- a/src/uml/qumlcreateobjectaction.h +++ b/src/uml/qumlcreateobjectaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlCreateObjectAction) *) -QT_END_HEADER - #endif // QUMLCREATEOBJECTACTION_H diff --git a/src/uml/qumldatastorenode.cpp b/src/uml/qumldatastorenode.cpp index 267f5091..602436b2 100644 --- a/src/uml/qumldatastorenode.cpp +++ b/src/uml/qumldatastorenode.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief A data store node is a central buffer node for non-transient information. */ + +/*! + Creates a new QUmlDataStoreNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDataStoreNode::QUmlDataStoreNode(bool createQModelingObject) : QUmlCentralBufferNode(false) { @@ -79,6 +83,9 @@ QUmlDataStoreNode::QUmlDataStoreNode(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDataStoreNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDataStoreNode. +*/ QModelingElement *QUmlDataStoreNode::clone() const { QUmlDataStoreNode *c = new QUmlDataStoreNode; diff --git a/src/uml/qumldatastorenode.h b/src/uml/qumldatastorenode.h index bcaa93cb..69cbb7a7 100644 --- a/src/uml/qumldatastorenode.h +++ b/src/uml/qumldatastorenode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlCentralBufferNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDataStoreNode) *) -QT_END_HEADER - #endif // QUMLDATASTORENODE_H diff --git a/src/uml/qumldatatype.cpp b/src/uml/qumldatatype.cpp index e2e9377a..015a0bf1 100644 --- a/src/uml/qumldatatype.cpp +++ b/src/uml/qumldatatype.cpp @@ -79,12 +79,19 @@ QT_BEGIN_NAMESPACE \brief A data type is a type whose instances are identified only by their value. A data type may contain attributes to support the modeling of structured data types. */ + +/*! + Creates a new QUmlDataType. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDataType::QUmlDataType(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDataTypeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDataType. +*/ QModelingElement *QUmlDataType::clone() const { QUmlDataType *c = new QUmlDataType; @@ -142,6 +149,12 @@ QModelingElement *QUmlDataType::clone() const /*! The Attributes owned by the DataType. + + \sa addOwnedAttribute(), removeOwnedAttribute() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(), QUmlClassifier::attributes(). + + \b {Opposite property(ies):} QUmlProperty::datatype(). */ const QList<QUmlProperty *> QUmlDataType::ownedAttributes() const { @@ -150,6 +163,11 @@ const QList<QUmlProperty *> QUmlDataType::ownedAttributes() const return _ownedAttributes; } +/*! + Adds \a ownedAttribute to ownedAttributes. + + \sa ownedAttributes(), removeOwnedAttribute() + */ void QUmlDataType::addOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end @@ -171,6 +189,11 @@ void QUmlDataType::addOwnedAttribute(QUmlProperty *ownedAttribute) } } +/*! + Removes \a ownedAttribute from ownedAttributes. + + \sa ownedAttributes(), addOwnedAttribute() + */ void QUmlDataType::removeOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end @@ -193,6 +216,12 @@ void QUmlDataType::removeOwnedAttribute(QUmlProperty *ownedAttribute) /*! The Operations owned by the DataType. + + \sa addOwnedOperation(), removeOwnedOperation() + + \b {Subsetted property(ies):} QUmlClassifier::features(), QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlOperation::datatype(). */ const QList<QUmlOperation *> QUmlDataType::ownedOperations() const { @@ -201,6 +230,11 @@ const QList<QUmlOperation *> QUmlDataType::ownedOperations() const return _ownedOperations; } +/*! + Adds \a ownedOperation to ownedOperations. + + \sa ownedOperations(), removeOwnedOperation() + */ void QUmlDataType::addOwnedOperation(QUmlOperation *ownedOperation) { // This is a read-write association end @@ -222,6 +256,11 @@ void QUmlDataType::addOwnedOperation(QUmlOperation *ownedOperation) } } +/*! + Removes \a ownedOperation from ownedOperations. + + \sa ownedOperations(), addOwnedOperation() + */ void QUmlDataType::removeOwnedOperation(QUmlOperation *ownedOperation) { // This is a read-write association end diff --git a/src/uml/qumldatatype.h b/src/uml/qumldatatype.h index 3643a820..98b925f0 100644 --- a/src/uml/qumldatatype.h +++ b/src/uml/qumldatatype.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -82,7 +80,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDataType) *) -QT_END_HEADER - #endif // QUMLDATATYPE_H diff --git a/src/uml/qumldecisionnode.cpp b/src/uml/qumldecisionnode.cpp index aee92bf8..e6366a9f 100644 --- a/src/uml/qumldecisionnode.cpp +++ b/src/uml/qumldecisionnode.cpp @@ -70,6 +70,10 @@ QT_BEGIN_NAMESPACE \brief A decision node is a control node that chooses between outgoing flows. */ + +/*! + Creates a new QUmlDecisionNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDecisionNode::QUmlDecisionNode(bool createQModelingObject) : _decisionInput(0), _decisionInputFlow(0) @@ -78,6 +82,9 @@ QUmlDecisionNode::QUmlDecisionNode(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDecisionNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDecisionNode. +*/ QModelingElement *QUmlDecisionNode::clone() const { QUmlDecisionNode *c = new QUmlDecisionNode; @@ -123,6 +130,9 @@ QUmlBehavior *QUmlDecisionNode::decisionInput() const return _decisionInput; } +/*! + Adjusts decisionInput to \a decisionInput. + */ void QUmlDecisionNode::setDecisionInput(QUmlBehavior *decisionInput) { // This is a read-write association end @@ -144,6 +154,9 @@ QUmlObjectFlow *QUmlDecisionNode::decisionInputFlow() const return _decisionInputFlow; } +/*! + Adjusts decisionInputFlow to \a decisionInputFlow. + */ void QUmlDecisionNode::setDecisionInputFlow(QUmlObjectFlow *decisionInputFlow) { // This is a read-write association end diff --git a/src/uml/qumldecisionnode.h b/src/uml/qumldecisionnode.h index cb0c389e..07cf9999 100644 --- a/src/uml/qumldecisionnode.h +++ b/src/uml/qumldecisionnode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlControlNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDecisionNode) *) -QT_END_HEADER - #endif // QUMLDECISIONNODE_H diff --git a/src/uml/qumldependency.cpp b/src/uml/qumldependency.cpp index db2eeeb5..6620b41e 100644 --- a/src/uml/qumldependency.cpp +++ b/src/uml/qumldependency.cpp @@ -60,12 +60,19 @@ QT_BEGIN_NAMESPACE \brief A dependency is a relationship that signifies that a single or a set of model elements requires other model elements for their specification or implementation. This means that the complete semantics of the depending elements is either semantically or structurally dependent on the definition of the supplier element(s). */ + +/*! + Creates a new QUmlDependency. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDependency::QUmlDependency(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDependencyObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDependency. +*/ QModelingElement *QUmlDependency::clone() const { QUmlDependency *c = new QUmlDependency; @@ -92,6 +99,12 @@ QModelingElement *QUmlDependency::clone() const /*! The element(s) dependent on the supplier element(s). In some cases (such as a Trace Abstraction) the assignment of direction (that is, the designation of the client element) is at the discretion of the modeler, and is a stipulation. + + \sa addClient(), removeClient() + + \b {Subsetted property(ies):} QUmlDirectedRelationship::sources(). + + \b {Opposite property(ies):} QUmlNamedElement::clientDependencies(). */ const QSet<QUmlNamedElement *> QUmlDependency::clients() const { @@ -100,6 +113,11 @@ const QSet<QUmlNamedElement *> QUmlDependency::clients() const return _clients; } +/*! + Adds \a client to clients. + + \sa clients(), removeClient() + */ void QUmlDependency::addClient(QUmlNamedElement *client) { // This is a read-write association end @@ -119,6 +137,11 @@ void QUmlDependency::addClient(QUmlNamedElement *client) } } +/*! + Removes \a client from clients. + + \sa clients(), addClient() + */ void QUmlDependency::removeClient(QUmlNamedElement *client) { // This is a read-write association end @@ -138,6 +161,10 @@ void QUmlDependency::removeClient(QUmlNamedElement *client) /*! The element(s) independent of the client element(s), in the same respect and the same dependency relationship. In some directed dependency relationships (such as Refinement Abstractions), a common convention in the domain of class-based OO software is to put the more abstract element in this role. Despite this convention, users of UML may stipulate a sense of dependency suitable for their domain, which makes a more abstract element dependent on that which is more specific. + + \sa addSupplier(), removeSupplier() + + \b {Subsetted property(ies):} QUmlDirectedRelationship::targets(). */ const QSet<QUmlNamedElement *> QUmlDependency::suppliers() const { @@ -146,6 +173,11 @@ const QSet<QUmlNamedElement *> QUmlDependency::suppliers() const return _suppliers; } +/*! + Adds \a supplier to suppliers. + + \sa suppliers(), removeSupplier() + */ void QUmlDependency::addSupplier(QUmlNamedElement *supplier) { // This is a read-write association end @@ -160,6 +192,11 @@ void QUmlDependency::addSupplier(QUmlNamedElement *supplier) } } +/*! + Removes \a supplier from suppliers. + + \sa suppliers(), addSupplier() + */ void QUmlDependency::removeSupplier(QUmlNamedElement *supplier) { // This is a read-write association end diff --git a/src/uml/qumldependency.h b/src/uml/qumldependency.h index eb3e2817..b0f75b8b 100644 --- a/src/uml/qumldependency.h +++ b/src/uml/qumldependency.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlPackageableElement> #include <QtUml/QUmlDirectedRelationship> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -78,7 +76,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDependency) *) -QT_END_HEADER - #endif // QUMLDEPENDENCY_H diff --git a/src/uml/qumldeployedartifact.cpp b/src/uml/qumldeployedartifact.cpp index 11978e7b..a1b3f2dc 100644 --- a/src/uml/qumldeployedartifact.cpp +++ b/src/uml/qumldeployedartifact.cpp @@ -55,11 +55,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A deployed artifact is an artifact or artifact instance that has been deployed to a deployment target. + + \b {QUmlDeployedArtifact is an abstract class.} */ + +/*! + Creates a new QUmlDeployedArtifact. +*/ QUmlDeployedArtifact::QUmlDeployedArtifact() { } +/*! + Returns a deep-copied clone of the QUmlDeployedArtifact. +*/ QModelingElement *QUmlDeployedArtifact::clone() const { QUmlDeployedArtifact *c = new QUmlDeployedArtifact; diff --git a/src/uml/qumldeployedartifact.h b/src/uml/qumldeployedartifact.h index 79791412..10305ec7 100644 --- a/src/uml/qumldeployedartifact.h +++ b/src/uml/qumldeployedartifact.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDeployedArtifact) *) -QT_END_HEADER - #endif // QUMLDEPLOYEDARTIFACT_H diff --git a/src/uml/qumldeployment.cpp b/src/uml/qumldeployment.cpp index 25607c92..a536ed3d 100644 --- a/src/uml/qumldeployment.cpp +++ b/src/uml/qumldeployment.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief A deployment is the allocation of an artifact or artifact instance to a deployment target.A component deployment is the deployment of one or more artifacts or artifact instances to a deployment target, optionally parameterized by a deployment specification. Examples are executables and configuration files. */ + +/*! + Creates a new QUmlDeployment. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDeployment::QUmlDeployment(bool createQModelingObject) : QUmlDependency(false), _location(0) @@ -71,6 +75,9 @@ QUmlDeployment::QUmlDeployment(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDeploymentObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDeployment. +*/ QModelingElement *QUmlDeployment::clone() const { QUmlDeployment *c = new QUmlDeployment; @@ -103,6 +110,12 @@ QModelingElement *QUmlDeployment::clone() const /*! The specification of properties that parameterize the deployment and execution of one or more Artifacts. + + \sa addConfiguration(), removeConfiguration() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlDeploymentSpecification::deployment(). */ const QSet<QUmlDeploymentSpecification *> QUmlDeployment::configurations() const { @@ -111,6 +124,11 @@ const QSet<QUmlDeploymentSpecification *> QUmlDeployment::configurations() const return _configurations; } +/*! + Adds \a configuration to configurations. + + \sa configurations(), removeConfiguration() + */ void QUmlDeployment::addConfiguration(QUmlDeploymentSpecification *configuration) { // This is a read-write association end @@ -131,6 +149,11 @@ void QUmlDeployment::addConfiguration(QUmlDeploymentSpecification *configuration } } +/*! + Removes \a configuration from configurations. + + \sa configurations(), addConfiguration() + */ void QUmlDeployment::removeConfiguration(QUmlDeploymentSpecification *configuration) { // This is a read-write association end @@ -152,6 +175,10 @@ void QUmlDeployment::removeConfiguration(QUmlDeploymentSpecification *configurat /*! The Artifacts that are deployed onto a Node. This association specializes the supplier association. + + \sa addDeployedArtifact(), removeDeployedArtifact() + + \b {Subsetted property(ies):} QUmlDependency::suppliers(). */ const QSet<QUmlDeployedArtifact *> QUmlDeployment::deployedArtifacts() const { @@ -160,6 +187,11 @@ const QSet<QUmlDeployedArtifact *> QUmlDeployment::deployedArtifacts() const return _deployedArtifacts; } +/*! + Adds \a deployedArtifact to deployedArtifacts. + + \sa deployedArtifacts(), removeDeployedArtifact() + */ void QUmlDeployment::addDeployedArtifact(QUmlDeployedArtifact *deployedArtifact) { // This is a read-write association end @@ -174,6 +206,11 @@ void QUmlDeployment::addDeployedArtifact(QUmlDeployedArtifact *deployedArtifact) } } +/*! + Removes \a deployedArtifact from deployedArtifacts. + + \sa deployedArtifacts(), addDeployedArtifact() + */ void QUmlDeployment::removeDeployedArtifact(QUmlDeployedArtifact *deployedArtifact) { // This is a read-write association end @@ -188,6 +225,10 @@ void QUmlDeployment::removeDeployedArtifact(QUmlDeployedArtifact *deployedArtifa /*! The DeployedTarget which is the target of a Deployment. + + \b {Subsetted property(ies):} QUmlElement::owner(), QUmlDependency::clients(). + + \b {Opposite property(ies):} QUmlDeploymentTarget::deployments(). */ QUmlDeploymentTarget *QUmlDeployment::location() const { @@ -196,6 +237,9 @@ QUmlDeploymentTarget *QUmlDeployment::location() const return _location; } +/*! + Adjusts location to \a location. + */ void QUmlDeployment::setLocation(QUmlDeploymentTarget *location) { // This is a read-write association end diff --git a/src/uml/qumldeployment.h b/src/uml/qumldeployment.h index 6982c5ca..c1342528 100644 --- a/src/uml/qumldeployment.h +++ b/src/uml/qumldeployment.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlDependency> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -82,7 +80,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDeployment) *) -QT_END_HEADER - #endif // QUMLDEPLOYMENT_H diff --git a/src/uml/qumldeploymentspecification.cpp b/src/uml/qumldeploymentspecification.cpp index 3917f56b..c9188596 100644 --- a/src/uml/qumldeploymentspecification.cpp +++ b/src/uml/qumldeploymentspecification.cpp @@ -82,6 +82,10 @@ QT_BEGIN_NAMESPACE \brief A deployment specification specifies a set of properties that determine execution parameters of a component artifact that is deployed on a node. A deployment specification can be aimed at a specific type of container. An artifact that reifies or implements deployment specification properties is a deployment descriptor. */ + +/*! + Creates a new QUmlDeploymentSpecification. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDeploymentSpecification::QUmlDeploymentSpecification(bool createQModelingObject) : QUmlArtifact(false), _deployment(0) @@ -90,6 +94,9 @@ QUmlDeploymentSpecification::QUmlDeploymentSpecification(bool createQModelingObj _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDeploymentSpecificationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDeploymentSpecification. +*/ QModelingElement *QUmlDeploymentSpecification::clone() const { QUmlDeploymentSpecification *c = new QUmlDeploymentSpecification; @@ -156,6 +163,10 @@ QModelingElement *QUmlDeploymentSpecification::clone() const /*! The deployment with which the DeploymentSpecification is associated. + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlDeployment::configurations(). */ QUmlDeployment *QUmlDeploymentSpecification::deployment() const { @@ -164,6 +175,9 @@ QUmlDeployment *QUmlDeploymentSpecification::deployment() const return _deployment; } +/*! + Adjusts deployment to \a deployment. + */ void QUmlDeploymentSpecification::setDeployment(QUmlDeployment *deployment) { // This is a read-write association end @@ -190,6 +204,9 @@ QString QUmlDeploymentSpecification::deploymentLocation() const return _deploymentLocation; } +/*! + Adjusts deploymentLocation to \a deploymentLocation. + */ void QUmlDeploymentSpecification::setDeploymentLocation(QString deploymentLocation) { // This is a read-write property @@ -209,6 +226,9 @@ QString QUmlDeploymentSpecification::executionLocation() const return _executionLocation; } +/*! + Adjusts executionLocation to \a executionLocation. + */ void QUmlDeploymentSpecification::setExecutionLocation(QString executionLocation) { // This is a read-write property diff --git a/src/uml/qumldeploymentspecification.h b/src/uml/qumldeploymentspecification.h index 5e3dffbc..0f1df929 100644 --- a/src/uml/qumldeploymentspecification.h +++ b/src/uml/qumldeploymentspecification.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlArtifact> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -78,7 +76,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDeploymentSpecification) *) -QT_END_HEADER - #endif // QUMLDEPLOYMENTSPECIFICATION_H diff --git a/src/uml/qumldeploymenttarget.cpp b/src/uml/qumldeploymenttarget.cpp index ed8282f0..ac1c14b5 100644 --- a/src/uml/qumldeploymenttarget.cpp +++ b/src/uml/qumldeploymenttarget.cpp @@ -57,11 +57,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A deployment target is the location for a deployed artifact. + + \b {QUmlDeploymentTarget is an abstract class.} */ + +/*! + Creates a new QUmlDeploymentTarget. +*/ QUmlDeploymentTarget::QUmlDeploymentTarget() { } +/*! + Returns a deep-copied clone of the QUmlDeploymentTarget. +*/ QModelingElement *QUmlDeploymentTarget::clone() const { QUmlDeploymentTarget *c = new QUmlDeploymentTarget; @@ -82,6 +91,8 @@ QModelingElement *QUmlDeploymentTarget::clone() const /*! The set of elements that are manifested in an Artifact that is involved in Deployment to a DeploymentTarget. + + \b {This is a read-only derived property.} */ const QSet<QUmlPackageableElement *> QUmlDeploymentTarget::deployedElements() const { @@ -92,6 +103,11 @@ const QSet<QUmlPackageableElement *> QUmlDeploymentTarget::deployedElements() co return QSet<QUmlPackageableElement *>(); } +/*! + Adds \a deployedElement to deployedElements. + + \sa deployedElements(), removeDeployedElement() + */ void QUmlDeploymentTarget::addDeployedElement(QUmlPackageableElement *deployedElement) { // This is a read-only derived association end @@ -104,6 +120,11 @@ void QUmlDeploymentTarget::addDeployedElement(QUmlPackageableElement *deployedEl } } +/*! + Removes \a deployedElement from deployedElements. + + \sa deployedElements(), addDeployedElement() + */ void QUmlDeploymentTarget::removeDeployedElement(QUmlPackageableElement *deployedElement) { // This is a read-only derived association end @@ -118,6 +139,12 @@ void QUmlDeploymentTarget::removeDeployedElement(QUmlPackageableElement *deploye /*! The set of Deployments for a DeploymentTarget. + + \sa addDeployment(), removeDeployment() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(), QUmlNamedElement::clientDependencies(). + + \b {Opposite property(ies):} QUmlDeployment::location(). */ const QSet<QUmlDeployment *> QUmlDeploymentTarget::deployments() const { @@ -126,6 +153,11 @@ const QSet<QUmlDeployment *> QUmlDeploymentTarget::deployments() const return _deployments; } +/*! + Adds \a deployment to deployments. + + \sa deployments(), removeDeployment() + */ void QUmlDeploymentTarget::addDeployment(QUmlDeployment *deployment) { // This is a read-write association end @@ -147,6 +179,11 @@ void QUmlDeploymentTarget::addDeployment(QUmlDeployment *deployment) } } +/*! + Removes \a deployment from deployments. + + \sa deployments(), addDeployment() + */ void QUmlDeploymentTarget::removeDeployment(QUmlDeployment *deployment) { // This is a read-write association end diff --git a/src/uml/qumldeploymenttarget.h b/src/uml/qumldeploymenttarget.h index 15286c43..5937dc8f 100644 --- a/src/uml/qumldeploymenttarget.h +++ b/src/uml/qumldeploymenttarget.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -77,7 +75,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDeploymentTarget) *) -QT_END_HEADER - #endif // QUMLDEPLOYMENTTARGET_H diff --git a/src/uml/qumldestroylinkaction.cpp b/src/uml/qumldestroylinkaction.cpp index 6f6030c4..2e47de9d 100644 --- a/src/uml/qumldestroylinkaction.cpp +++ b/src/uml/qumldestroylinkaction.cpp @@ -75,12 +75,19 @@ QT_BEGIN_NAMESPACE \brief A destroy link action is a write link action that destroys links and link objects. */ + +/*! + Creates a new QUmlDestroyLinkAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDestroyLinkAction::QUmlDestroyLinkAction(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDestroyLinkActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDestroyLinkAction. +*/ QModelingElement *QUmlDestroyLinkAction::clone() const { QUmlDestroyLinkAction *c = new QUmlDestroyLinkAction; @@ -125,6 +132,10 @@ QModelingElement *QUmlDestroyLinkAction::clone() const /*! Specifies ends of association and inputs. + + \sa addEndData(), removeEndData() + + \b {Redefined property(ies):} QUmlLinkAction::endData(). */ const QSet<QUmlLinkEndDestructionData *> QUmlDestroyLinkAction::endData() const { @@ -133,6 +144,11 @@ const QSet<QUmlLinkEndDestructionData *> QUmlDestroyLinkAction::endData() const return _endData; } +/*! + Adds \a endData to endData. + + \sa endData(), removeEndData() + */ void QUmlDestroyLinkAction::addEndData(QUmlLinkEndDestructionData *endData) { // This is a read-write association end @@ -148,6 +164,11 @@ void QUmlDestroyLinkAction::addEndData(QUmlLinkEndDestructionData *endData) } } +/*! + Removes \a endData from endData. + + \sa endData(), addEndData() + */ void QUmlDestroyLinkAction::removeEndData(QUmlLinkEndDestructionData *endData) { // This is a read-write association end diff --git a/src/uml/qumldestroylinkaction.h b/src/uml/qumldestroylinkaction.h index 7ee34b4b..861fded6 100644 --- a/src/uml/qumldestroylinkaction.h +++ b/src/uml/qumldestroylinkaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlWriteLinkAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -73,7 +71,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDestroyLinkAction) *) -QT_END_HEADER - #endif // QUMLDESTROYLINKACTION_H diff --git a/src/uml/qumldestroyobjectaction.cpp b/src/uml/qumldestroyobjectaction.cpp index 34afa180..7a294723 100644 --- a/src/uml/qumldestroyobjectaction.cpp +++ b/src/uml/qumldestroyobjectaction.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief A destroy object action is an action that destroys objects. */ + +/*! + Creates a new QUmlDestroyObjectAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDestroyObjectAction::QUmlDestroyObjectAction(bool createQModelingObject) : _isDestroyLinks(false), _isDestroyOwnedObjects(false), @@ -81,6 +85,9 @@ QUmlDestroyObjectAction::QUmlDestroyObjectAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDestroyObjectActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDestroyObjectAction. +*/ QModelingElement *QUmlDestroyObjectAction::clone() const { QUmlDestroyObjectAction *c = new QUmlDestroyObjectAction; @@ -133,6 +140,9 @@ bool QUmlDestroyObjectAction::isDestroyLinks() const return _isDestroyLinks; } +/*! + Adjusts isDestroyLinks to \a isDestroyLinks. + */ void QUmlDestroyObjectAction::setDestroyLinks(bool isDestroyLinks) { // This is a read-write property @@ -153,6 +163,9 @@ bool QUmlDestroyObjectAction::isDestroyOwnedObjects() const return _isDestroyOwnedObjects; } +/*! + Adjusts isDestroyOwnedObjects to \a isDestroyOwnedObjects. + */ void QUmlDestroyObjectAction::setDestroyOwnedObjects(bool isDestroyOwnedObjects) { // This is a read-write property @@ -165,6 +178,8 @@ void QUmlDestroyObjectAction::setDestroyOwnedObjects(bool isDestroyOwnedObjects) /*! The input pin providing the object to be destroyed. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlDestroyObjectAction::target() const { @@ -173,6 +188,9 @@ QUmlInputPin *QUmlDestroyObjectAction::target() const return _target; } +/*! + Adjusts target to \a target. + */ void QUmlDestroyObjectAction::setTarget(QUmlInputPin *target) { // This is a read-write association end diff --git a/src/uml/qumldestroyobjectaction.h b/src/uml/qumldestroyobjectaction.h index adae4aeb..2bdc594e 100644 --- a/src/uml/qumldestroyobjectaction.h +++ b/src/uml/qumldestroyobjectaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -78,7 +76,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDestroyObjectAction) *) -QT_END_HEADER - #endif // QUMLDESTROYOBJECTACTION_H diff --git a/src/uml/qumldestructionoccurrencespecification.cpp b/src/uml/qumldestructionoccurrencespecification.cpp index 9bff2b9a..6174684c 100644 --- a/src/uml/qumldestructionoccurrencespecification.cpp +++ b/src/uml/qumldestructionoccurrencespecification.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief A destruction event models the destruction of an object. */ + +/*! + Creates a new QUmlDestructionOccurrenceSpecification. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDestructionOccurrenceSpecification::QUmlDestructionOccurrenceSpecification(bool createQModelingObject) : QUmlMessageOccurrenceSpecification(false) { @@ -71,6 +75,9 @@ QUmlDestructionOccurrenceSpecification::QUmlDestructionOccurrenceSpecification(b _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDestructionOccurrenceSpecificationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDestructionOccurrenceSpecification. +*/ QModelingElement *QUmlDestructionOccurrenceSpecification::clone() const { QUmlDestructionOccurrenceSpecification *c = new QUmlDestructionOccurrenceSpecification; diff --git a/src/uml/qumldestructionoccurrencespecification.h b/src/uml/qumldestructionoccurrencespecification.h index 23e3326d..59fecfc8 100644 --- a/src/uml/qumldestructionoccurrencespecification.h +++ b/src/uml/qumldestructionoccurrencespecification.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlMessageOccurrenceSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDestructionOccurrenceSpecification) *) -QT_END_HEADER - #endif // QUMLDESTRUCTIONOCCURRENCESPECIFICATION_H diff --git a/src/uml/qumldevice.cpp b/src/uml/qumldevice.cpp index 3a6cafd2..a6869a40 100644 --- a/src/uml/qumldevice.cpp +++ b/src/uml/qumldevice.cpp @@ -89,6 +89,10 @@ QT_BEGIN_NAMESPACE \brief A device is a physical computational resource with processing capability upon which artifacts may be deployed for execution. Devices may be complex (i.e., they may consist of other devices). */ + +/*! + Creates a new QUmlDevice. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDevice::QUmlDevice(bool createQModelingObject) : QUmlNode(false) { @@ -96,6 +100,9 @@ QUmlDevice::QUmlDevice(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDeviceObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDevice. +*/ QModelingElement *QUmlDevice::clone() const { QUmlDevice *c = new QUmlDevice; diff --git a/src/uml/qumldevice.h b/src/uml/qumldevice.h index 51a5b825..58f84cc6 100644 --- a/src/uml/qumldevice.h +++ b/src/uml/qumldevice.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDevice) *) -QT_END_HEADER - #endif // QUMLDEVICE_H diff --git a/src/uml/qumldirectedrelationship.cpp b/src/uml/qumldirectedrelationship.cpp index 3d72270a..419b34aa 100644 --- a/src/uml/qumldirectedrelationship.cpp +++ b/src/uml/qumldirectedrelationship.cpp @@ -51,11 +51,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A directed relationship represents a relationship between a collection of source model elements and a collection of target model elements. + + \b {QUmlDirectedRelationship is an abstract class.} */ + +/*! + Creates a new QUmlDirectedRelationship. +*/ QUmlDirectedRelationship::QUmlDirectedRelationship() { } +/*! + Returns a deep-copied clone of the QUmlDirectedRelationship. +*/ QModelingElement *QUmlDirectedRelationship::clone() const { QUmlDirectedRelationship *c = new QUmlDirectedRelationship; @@ -68,6 +77,10 @@ QModelingElement *QUmlDirectedRelationship::clone() const /*! Specifies the sources of the DirectedRelationship. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} QUmlRelationship::relatedElements(). */ const QSet<QUmlElement *> QUmlDirectedRelationship::sources() const { @@ -76,6 +89,11 @@ const QSet<QUmlElement *> QUmlDirectedRelationship::sources() const return _sources; } +/*! + Adds \a source to sources. + + \sa sources(), removeSource() + */ void QUmlDirectedRelationship::addSource(QUmlElement *source) { // This is a read-only derived union association end @@ -90,6 +108,11 @@ void QUmlDirectedRelationship::addSource(QUmlElement *source) } } +/*! + Removes \a source from sources. + + \sa sources(), addSource() + */ void QUmlDirectedRelationship::removeSource(QUmlElement *source) { // This is a read-only derived union association end @@ -104,6 +127,10 @@ void QUmlDirectedRelationship::removeSource(QUmlElement *source) /*! Specifies the targets of the DirectedRelationship. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} QUmlRelationship::relatedElements(). */ const QSet<QUmlElement *> QUmlDirectedRelationship::targets() const { @@ -112,6 +139,11 @@ const QSet<QUmlElement *> QUmlDirectedRelationship::targets() const return _targets; } +/*! + Adds \a target to targets. + + \sa targets(), removeTarget() + */ void QUmlDirectedRelationship::addTarget(QUmlElement *target) { // This is a read-only derived union association end @@ -126,6 +158,11 @@ void QUmlDirectedRelationship::addTarget(QUmlElement *target) } } +/*! + Removes \a target from targets. + + \sa targets(), addTarget() + */ void QUmlDirectedRelationship::removeTarget(QUmlElement *target) { // This is a read-only derived union association end diff --git a/src/uml/qumldirectedrelationship.h b/src/uml/qumldirectedrelationship.h index ffd79c4b..d67e4c4d 100644 --- a/src/uml/qumldirectedrelationship.h +++ b/src/uml/qumldirectedrelationship.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlRelationship> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -77,7 +75,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDirectedRelationship) *) -QT_END_HEADER - #endif // QUMLDIRECTEDRELATIONSHIP_H diff --git a/src/uml/qumlduration.cpp b/src/uml/qumlduration.cpp index 5438d0a7..f44e7386 100644 --- a/src/uml/qumlduration.cpp +++ b/src/uml/qumlduration.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief Duration defines a value specification that specifies the temporal distance between two time instants. */ + +/*! + Creates a new QUmlDuration. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDuration::QUmlDuration(bool createQModelingObject) : _expr(0) { @@ -70,6 +74,9 @@ QUmlDuration::QUmlDuration(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDurationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDuration. +*/ QModelingElement *QUmlDuration::clone() const { QUmlDuration *c = new QUmlDuration; @@ -98,6 +105,8 @@ QModelingElement *QUmlDuration::clone() const /*! The value of the Duration. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlDuration::expr() const { @@ -106,6 +115,9 @@ QUmlValueSpecification *QUmlDuration::expr() const return _expr; } +/*! + Adjusts expr to \a expr. + */ void QUmlDuration::setExpr(QUmlValueSpecification *expr) { // This is a read-write association end @@ -128,6 +140,8 @@ void QUmlDuration::setExpr(QUmlValueSpecification *expr) /*! Refers to the time and duration observations that are involved in expr. + + \sa addObservation(), removeObservation() */ const QSet<QUmlObservation *> QUmlDuration::observations() const { @@ -136,6 +150,11 @@ const QSet<QUmlObservation *> QUmlDuration::observations() const return _observations; } +/*! + Adds \a observation to observations. + + \sa observations(), removeObservation() + */ void QUmlDuration::addObservation(QUmlObservation *observation) { // This is a read-write association end @@ -147,6 +166,11 @@ void QUmlDuration::addObservation(QUmlObservation *observation) } } +/*! + Removes \a observation from observations. + + \sa observations(), addObservation() + */ void QUmlDuration::removeObservation(QUmlObservation *observation) { // This is a read-write association end diff --git a/src/uml/qumlduration.h b/src/uml/qumlduration.h index 0a783a44..9e4a778a 100644 --- a/src/uml/qumlduration.h +++ b/src/uml/qumlduration.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlValueSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDuration) *) -QT_END_HEADER - #endif // QUMLDURATION_H diff --git a/src/uml/qumldurationconstraint.cpp b/src/uml/qumldurationconstraint.cpp index bb1fa7ba..c0c7852f 100644 --- a/src/uml/qumldurationconstraint.cpp +++ b/src/uml/qumldurationconstraint.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief A duration constraint is a constraint that refers to a duration interval. */ + +/*! + Creates a new QUmlDurationConstraint. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDurationConstraint::QUmlDurationConstraint(bool createQModelingObject) : QUmlIntervalConstraint(false), _specification(0) @@ -72,6 +76,9 @@ QUmlDurationConstraint::QUmlDurationConstraint(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDurationConstraintObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDurationConstraint. +*/ QModelingElement *QUmlDurationConstraint::clone() const { QUmlDurationConstraint *c = new QUmlDurationConstraint; @@ -109,6 +116,9 @@ bool QUmlDurationConstraint::firstEvent() const return _firstEvent; } +/*! + Adjusts firstEvent to \a firstEvent. + */ void QUmlDurationConstraint::setFirstEvent(bool firstEvent) { // This is a read-write property @@ -120,6 +130,8 @@ void QUmlDurationConstraint::setFirstEvent(bool firstEvent) /*! The interval constraining the duration. + + \b {Redefined property(ies):} QUmlIntervalConstraint::specification(). */ QUmlDurationInterval *QUmlDurationConstraint::specification() const { @@ -128,6 +140,9 @@ QUmlDurationInterval *QUmlDurationConstraint::specification() const return _specification; } +/*! + Adjusts specification to \a specification. + */ void QUmlDurationConstraint::setSpecification(QUmlDurationInterval *specification) { // This is a read-write association end diff --git a/src/uml/qumldurationconstraint.h b/src/uml/qumldurationconstraint.h index 9fa3b47e..70ad9b3e 100644 --- a/src/uml/qumldurationconstraint.h +++ b/src/uml/qumldurationconstraint.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlIntervalConstraint> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDurationConstraint) *) -QT_END_HEADER - #endif // QUMLDURATIONCONSTRAINT_H diff --git a/src/uml/qumldurationinterval.cpp b/src/uml/qumldurationinterval.cpp index f5ff2dd0..17b00a89 100644 --- a/src/uml/qumldurationinterval.cpp +++ b/src/uml/qumldurationinterval.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief A duration interval defines the range between two durations. */ + +/*! + Creates a new QUmlDurationInterval. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDurationInterval::QUmlDurationInterval(bool createQModelingObject) : QUmlInterval(false), _max(0), @@ -73,6 +77,9 @@ QUmlDurationInterval::QUmlDurationInterval(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDurationIntervalObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDurationInterval. +*/ QModelingElement *QUmlDurationInterval::clone() const { QUmlDurationInterval *c = new QUmlDurationInterval; @@ -101,6 +108,8 @@ QModelingElement *QUmlDurationInterval::clone() const /*! Refers to the Duration denoting the maximum value of the range. + + \b {Redefined property(ies):} QUmlInterval::max(). */ QUmlDuration *QUmlDurationInterval::max() const { @@ -109,6 +118,9 @@ QUmlDuration *QUmlDurationInterval::max() const return _max; } +/*! + Adjusts max to \a max. + */ void QUmlDurationInterval::setMax(QUmlDuration *max) { // This is a read-write association end @@ -125,6 +137,8 @@ void QUmlDurationInterval::setMax(QUmlDuration *max) /*! Refers to the Duration denoting the minimum value of the range. + + \b {Redefined property(ies):} QUmlInterval::min(). */ QUmlDuration *QUmlDurationInterval::min() const { @@ -133,6 +147,9 @@ QUmlDuration *QUmlDurationInterval::min() const return _min; } +/*! + Adjusts min to \a min. + */ void QUmlDurationInterval::setMin(QUmlDuration *min) { // This is a read-write association end diff --git a/src/uml/qumldurationinterval.h b/src/uml/qumldurationinterval.h index a33d9232..c5a5a64f 100644 --- a/src/uml/qumldurationinterval.h +++ b/src/uml/qumldurationinterval.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInterval> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDurationInterval) *) -QT_END_HEADER - #endif // QUMLDURATIONINTERVAL_H diff --git a/src/uml/qumldurationobservation.cpp b/src/uml/qumldurationobservation.cpp index bcd0cb95..a2c36b4c 100644 --- a/src/uml/qumldurationobservation.cpp +++ b/src/uml/qumldurationobservation.cpp @@ -61,6 +61,10 @@ QT_BEGIN_NAMESPACE \brief A duration observation is a reference to a duration during an execution. It points out the element(s) in the model to observe and whether the observations are when this model element is entered or when it is exited. */ + +/*! + Creates a new QUmlDurationObservation. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlDurationObservation::QUmlDurationObservation(bool createQModelingObject) : _event_(0) { @@ -68,6 +72,9 @@ QUmlDurationObservation::QUmlDurationObservation(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlDurationObservationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlDurationObservation. +*/ QModelingElement *QUmlDurationObservation::clone() const { QUmlDurationObservation *c = new QUmlDurationObservation; @@ -101,6 +108,9 @@ QUmlNamedElement *QUmlDurationObservation::event_() const return _event_; } +/*! + Adjusts event_ to \a event_. + */ void QUmlDurationObservation::setEvent(QUmlNamedElement *event_) { // This is a read-write association end @@ -122,6 +132,9 @@ bool QUmlDurationObservation::firstEvent() const return _firstEvent; } +/*! + Adjusts firstEvent to \a firstEvent. + */ void QUmlDurationObservation::setFirstEvent(bool firstEvent) { // This is a read-write property diff --git a/src/uml/qumldurationobservation.h b/src/uml/qumldurationobservation.h index acad0704..f8310c5c 100644 --- a/src/uml/qumldurationobservation.h +++ b/src/uml/qumldurationobservation.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlObservation> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlDurationObservation) *) -QT_END_HEADER - #endif // QUMLDURATIONOBSERVATION_H diff --git a/src/uml/qumlelement.cpp b/src/uml/qumlelement.cpp index dc192c90..e26f1500 100644 --- a/src/uml/qumlelement.cpp +++ b/src/uml/qumlelement.cpp @@ -50,12 +50,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief An element is a constituent of a model. As such, it has the capability of owning other elements. + + \b {QUmlElement is an abstract class.} */ + +/*! + Creates a new QUmlElement. +*/ QUmlElement::QUmlElement() : _owner(0) { } +/*! + Returns a deep-copied clone of the QUmlElement. +*/ QModelingElement *QUmlElement::clone() const { QUmlElement *c = new QUmlElement; @@ -68,6 +77,10 @@ QModelingElement *QUmlElement::clone() const /*! The Comments owned by this element. + + \sa addOwnedComment(), removeOwnedComment() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlComment *> QUmlElement::ownedComments() const { @@ -76,6 +89,11 @@ const QSet<QUmlComment *> QUmlElement::ownedComments() const return _ownedComments; } +/*! + Adds \a ownedComment to ownedComments. + + \sa ownedComments(), removeOwnedComment() + */ void QUmlElement::addOwnedComment(QUmlComment *ownedComment) { // This is a read-write association end @@ -91,6 +109,11 @@ void QUmlElement::addOwnedComment(QUmlComment *ownedComment) } } +/*! + Removes \a ownedComment from ownedComments. + + \sa ownedComments(), addOwnedComment() + */ void QUmlElement::removeOwnedComment(QUmlComment *ownedComment) { // This is a read-write association end @@ -107,6 +130,10 @@ void QUmlElement::removeOwnedComment(QUmlComment *ownedComment) /*! The Elements owned by this element. + + \b {This is a read-only derived union property.} + + \b {Opposite property(ies):} QUmlElement::owner(). */ const QSet<QUmlElement *> QUmlElement::ownedElements() const { @@ -115,6 +142,11 @@ const QSet<QUmlElement *> QUmlElement::ownedElements() const return _ownedElements; } +/*! + Adds \a ownedElement to ownedElements. + + \sa ownedElements(), removeOwnedElement() + */ void QUmlElement::addOwnedElement(QUmlElement *ownedElement) { // This is a read-only derived union association end @@ -132,6 +164,11 @@ void QUmlElement::addOwnedElement(QUmlElement *ownedElement) } } +/*! + Removes \a ownedElement from ownedElements. + + \sa ownedElements(), addOwnedElement() + */ void QUmlElement::removeOwnedElement(QUmlElement *ownedElement) { // This is a read-only derived union association end @@ -150,6 +187,10 @@ void QUmlElement::removeOwnedElement(QUmlElement *ownedElement) /*! The Element that owns this element. + + \b {This is a read-only derived union property.} + + \b {Opposite property(ies):} QUmlElement::ownedElements(). */ QUmlElement *QUmlElement::owner() const { @@ -158,6 +199,9 @@ QUmlElement *QUmlElement::owner() const return _owner; } +/*! + Adjusts owner to \a owner. + */ void QUmlElement::setOwner(QUmlElement *owner) { // This is a read-only derived union association end diff --git a/src/uml/qumlelement.h b/src/uml/qumlelement.h index 7c96102a..5c3ed8be 100644 --- a/src/uml/qumlelement.h +++ b/src/uml/qumlelement.h @@ -45,8 +45,6 @@ #include <QtModeling/QModelingElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -87,7 +85,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlElement) *) -QT_END_HEADER - #endif // QUMLELEMENT_H diff --git a/src/uml/qumlelementimport.cpp b/src/uml/qumlelementimport.cpp index 8e7aba3c..55149b03 100644 --- a/src/uml/qumlelementimport.cpp +++ b/src/uml/qumlelementimport.cpp @@ -56,6 +56,10 @@ QT_BEGIN_NAMESPACE \brief An element import identifies an element in another package, and allows the element to be referenced using its name without a qualifier. */ + +/*! + Creates a new QUmlElementImport. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlElementImport::QUmlElementImport(bool createQModelingObject) : _importedElement(0), _importingNamespace(0), @@ -65,6 +69,9 @@ QUmlElementImport::QUmlElementImport(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlElementImportObject(this)); } +/*! + Returns a deep-copied clone of the QUmlElementImport. +*/ QModelingElement *QUmlElementImport::clone() const { QUmlElementImport *c = new QUmlElementImport; @@ -91,6 +98,9 @@ QString QUmlElementImport::alias() const return _alias; } +/*! + Adjusts alias to \a alias. + */ void QUmlElementImport::setAlias(QString alias) { // This is a read-write property @@ -102,6 +112,8 @@ void QUmlElementImport::setAlias(QString alias) /*! Specifies the PackageableElement whose name is to be added to a Namespace. + + \b {Subsetted property(ies):} QUmlDirectedRelationship::targets(). */ QUmlPackageableElement *QUmlElementImport::importedElement() const { @@ -110,6 +122,9 @@ QUmlPackageableElement *QUmlElementImport::importedElement() const return _importedElement; } +/*! + Adjusts importedElement to \a importedElement. + */ void QUmlElementImport::setImportedElement(QUmlPackageableElement *importedElement) { // This is a read-write association end @@ -131,6 +146,10 @@ void QUmlElementImport::setImportedElement(QUmlPackageableElement *importedEleme /*! Specifies the Namespace that imports a PackageableElement from another Package. + + \b {Subsetted property(ies):} QUmlElement::owner(), QUmlDirectedRelationship::sources(). + + \b {Opposite property(ies):} QUmlNamespace::elementImports(). */ QUmlNamespace *QUmlElementImport::importingNamespace() const { @@ -139,6 +158,9 @@ QUmlNamespace *QUmlElementImport::importingNamespace() const return _importingNamespace; } +/*! + Adjusts importingNamespace to \a importingNamespace. + */ void QUmlElementImport::setImportingNamespace(QUmlNamespace *importingNamespace) { // This is a read-write association end @@ -169,6 +191,9 @@ QtUml::VisibilityKind QUmlElementImport::visibility() const return _visibility; } +/*! + Adjusts visibility to \a visibility. + */ void QUmlElementImport::setVisibility(QtUml::VisibilityKind visibility) { // This is a read-write property diff --git a/src/uml/qumlelementimport.h b/src/uml/qumlelementimport.h index cc841c25..c056f51d 100644 --- a/src/uml/qumlelementimport.h +++ b/src/uml/qumlelementimport.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -87,7 +85,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlElementImport) *) -QT_END_HEADER - #endif // QUMLELEMENTIMPORT_H diff --git a/src/uml/qumlencapsulatedclassifier.cpp b/src/uml/qumlencapsulatedclassifier.cpp index 3b011476..b281380d 100644 --- a/src/uml/qumlencapsulatedclassifier.cpp +++ b/src/uml/qumlencapsulatedclassifier.cpp @@ -79,11 +79,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A classifier has the ability to own ports as specific and type checked interaction points. + + \b {QUmlEncapsulatedClassifier is an abstract class.} */ + +/*! + Creates a new QUmlEncapsulatedClassifier. +*/ QUmlEncapsulatedClassifier::QUmlEncapsulatedClassifier() { } +/*! + Returns a deep-copied clone of the QUmlEncapsulatedClassifier. +*/ QModelingElement *QUmlEncapsulatedClassifier::clone() const { QUmlEncapsulatedClassifier *c = new QUmlEncapsulatedClassifier; @@ -141,6 +150,10 @@ QModelingElement *QUmlEncapsulatedClassifier::clone() const /*! References a set of ports that an encapsulated classifier owns. + + \b {This is a read-only derived property.} + + \b {Subsetted property(ies):} QUmlStructuredClassifier::ownedAttributes(). */ const QSet<QUmlPort *> QUmlEncapsulatedClassifier::ownedPorts() const { @@ -155,6 +168,11 @@ const QSet<QUmlPort *> QUmlEncapsulatedClassifier::ownedPorts() const return _ownedPorts; } +/*! + Adds \a ownedPort to ownedPorts. + + \sa ownedPorts(), removeOwnedPort() + */ void QUmlEncapsulatedClassifier::addOwnedPort(QUmlPort *ownedPort) { // This is a read-only derived association end @@ -170,6 +188,11 @@ void QUmlEncapsulatedClassifier::addOwnedPort(QUmlPort *ownedPort) } } +/*! + Removes \a ownedPort from ownedPorts. + + \sa ownedPorts(), addOwnedPort() + */ void QUmlEncapsulatedClassifier::removeOwnedPort(QUmlPort *ownedPort) { // This is a read-only derived association end diff --git a/src/uml/qumlencapsulatedclassifier.h b/src/uml/qumlencapsulatedclassifier.h index 6308bd64..697f636d 100644 --- a/src/uml/qumlencapsulatedclassifier.h +++ b/src/uml/qumlencapsulatedclassifier.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlStructuredClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlEncapsulatedClassifier) *) -QT_END_HEADER - #endif // QUMLENCAPSULATEDCLASSIFIER_H diff --git a/src/uml/qumlenumeration.cpp b/src/uml/qumlenumeration.cpp index 8cd0b0be..b6544a4e 100644 --- a/src/uml/qumlenumeration.cpp +++ b/src/uml/qumlenumeration.cpp @@ -81,6 +81,10 @@ QT_BEGIN_NAMESPACE \brief An enumeration is a data type whose values are enumerated in the model as enumeration literals. */ + +/*! + Creates a new QUmlEnumeration. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlEnumeration::QUmlEnumeration(bool createQModelingObject) : QUmlDataType(false) { @@ -88,6 +92,9 @@ QUmlEnumeration::QUmlEnumeration(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlEnumerationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlEnumeration. +*/ QModelingElement *QUmlEnumeration::clone() const { QUmlEnumeration *c = new QUmlEnumeration; @@ -147,6 +154,12 @@ QModelingElement *QUmlEnumeration::clone() const /*! The ordered set of literals for this Enumeration. + + \sa addOwnedLiteral(), removeOwnedLiteral() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlEnumerationLiteral::enumeration(). */ const QList<QUmlEnumerationLiteral *> QUmlEnumeration::ownedLiterals() const { @@ -155,6 +168,11 @@ const QList<QUmlEnumerationLiteral *> QUmlEnumeration::ownedLiterals() const return _ownedLiterals; } +/*! + Adds \a ownedLiteral to ownedLiterals. + + \sa ownedLiterals(), removeOwnedLiteral() + */ void QUmlEnumeration::addOwnedLiteral(QUmlEnumerationLiteral *ownedLiteral) { // This is a read-write association end @@ -175,6 +193,11 @@ void QUmlEnumeration::addOwnedLiteral(QUmlEnumerationLiteral *ownedLiteral) } } +/*! + Removes \a ownedLiteral from ownedLiterals. + + \sa ownedLiterals(), addOwnedLiteral() + */ void QUmlEnumeration::removeOwnedLiteral(QUmlEnumerationLiteral *ownedLiteral) { // This is a read-write association end diff --git a/src/uml/qumlenumeration.h b/src/uml/qumlenumeration.h index 8ab67731..841219ba 100644 --- a/src/uml/qumlenumeration.h +++ b/src/uml/qumlenumeration.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlDataType> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -73,7 +71,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlEnumeration) *) -QT_END_HEADER - #endif // QUMLENUMERATION_H diff --git a/src/uml/qumlenumerationliteral.cpp b/src/uml/qumlenumerationliteral.cpp index 4b248a50..4d5c9ac9 100644 --- a/src/uml/qumlenumerationliteral.cpp +++ b/src/uml/qumlenumerationliteral.cpp @@ -67,6 +67,10 @@ QT_BEGIN_NAMESPACE \brief An enumeration literal is a user-defined data value for an enumeration. */ + +/*! + Creates a new QUmlEnumerationLiteral. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlEnumerationLiteral::QUmlEnumerationLiteral(bool createQModelingObject) : QUmlInstanceSpecification(false), _enumeration(0) @@ -75,6 +79,9 @@ QUmlEnumerationLiteral::QUmlEnumerationLiteral(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlEnumerationLiteralObject(this)); } +/*! + Returns a deep-copied clone of the QUmlEnumerationLiteral. +*/ QModelingElement *QUmlEnumerationLiteral::clone() const { QUmlEnumerationLiteral *c = new QUmlEnumerationLiteral; @@ -105,6 +112,10 @@ QModelingElement *QUmlEnumerationLiteral::clone() const /*! The classifier of this EnumerationLiteral derived to be equal to its enumeration. + + \b {This is a read-only derived property.} + + \b {Redefined property(ies):} QUmlInstanceSpecification::classifiers(). */ QUmlEnumeration *QUmlEnumerationLiteral::classifier() const { @@ -115,6 +126,9 @@ QUmlEnumeration *QUmlEnumerationLiteral::classifier() const return 0; } +/*! + Adjusts classifier to \a classifier. + */ void QUmlEnumerationLiteral::setClassifier(QUmlEnumeration *classifier) { // This is a read-only derived association end @@ -136,6 +150,10 @@ void QUmlEnumerationLiteral::setClassifier(QUmlEnumeration *classifier) /*! The Enumeration that this EnumerationLiteral is a member of. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlEnumeration::ownedLiterals(). */ QUmlEnumeration *QUmlEnumerationLiteral::enumeration() const { @@ -144,6 +162,9 @@ QUmlEnumeration *QUmlEnumerationLiteral::enumeration() const return _enumeration; } +/*! + Adjusts enumeration to \a enumeration. + */ void QUmlEnumerationLiteral::setEnumeration(QUmlEnumeration *enumeration) { // This is a read-write association end diff --git a/src/uml/qumlenumerationliteral.h b/src/uml/qumlenumerationliteral.h index 6d8b6d50..981c0d12 100644 --- a/src/uml/qumlenumerationliteral.h +++ b/src/uml/qumlenumerationliteral.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInstanceSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -74,7 +72,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlEnumerationLiteral) *) -QT_END_HEADER - #endif // QUMLENUMERATIONLITERAL_H diff --git a/src/uml/qumlevent.cpp b/src/uml/qumlevent.cpp index 3fa15073..094c3719 100644 --- a/src/uml/qumlevent.cpp +++ b/src/uml/qumlevent.cpp @@ -58,11 +58,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief An event is the specification of some occurrence that may potentially trigger effects by an object. + + \b {QUmlEvent is an abstract class.} */ + +/*! + Creates a new QUmlEvent. +*/ QUmlEvent::QUmlEvent() { } +/*! + Returns a deep-copied clone of the QUmlEvent. +*/ QModelingElement *QUmlEvent::clone() const { QUmlEvent *c = new QUmlEvent; diff --git a/src/uml/qumlevent.h b/src/uml/qumlevent.h index aca41d67..a5e7c1e6 100644 --- a/src/uml/qumlevent.h +++ b/src/uml/qumlevent.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlPackageableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlEvent) *) -QT_END_HEADER - #endif // QUMLEVENT_H diff --git a/src/uml/qumlexceptionhandler.cpp b/src/uml/qumlexceptionhandler.cpp index 0c89768e..c4905d4e 100644 --- a/src/uml/qumlexceptionhandler.cpp +++ b/src/uml/qumlexceptionhandler.cpp @@ -56,6 +56,10 @@ QT_BEGIN_NAMESPACE \brief An exception handler is an element that specifies a body to execute in case the specified exception occurs during the execution of the protected node. */ + +/*! + Creates a new QUmlExceptionHandler. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlExceptionHandler::QUmlExceptionHandler(bool createQModelingObject) : _exceptionInput(0), _handlerBody(0), @@ -65,6 +69,9 @@ QUmlExceptionHandler::QUmlExceptionHandler(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlExceptionHandlerObject(this)); } +/*! + Returns a deep-copied clone of the QUmlExceptionHandler. +*/ QModelingElement *QUmlExceptionHandler::clone() const { QUmlExceptionHandler *c = new QUmlExceptionHandler; @@ -93,6 +100,9 @@ QUmlObjectNode *QUmlExceptionHandler::exceptionInput() const return _exceptionInput; } +/*! + Adjusts exceptionInput to \a exceptionInput. + */ void QUmlExceptionHandler::setExceptionInput(QUmlObjectNode *exceptionInput) { // This is a read-write association end @@ -106,6 +116,8 @@ void QUmlExceptionHandler::setExceptionInput(QUmlObjectNode *exceptionInput) /*! The kind of instances that the handler catches. If an exception occurs whose type is any of the classifiers in the set, the handler catches the exception and executes its body. + + \sa addExceptionType(), removeExceptionType() */ const QSet<QUmlClassifier *> QUmlExceptionHandler::exceptionTypes() const { @@ -114,6 +126,11 @@ const QSet<QUmlClassifier *> QUmlExceptionHandler::exceptionTypes() const return _exceptionTypes; } +/*! + Adds \a exceptionType to exceptionTypes. + + \sa exceptionTypes(), removeExceptionType() + */ void QUmlExceptionHandler::addExceptionType(QUmlClassifier *exceptionType) { // This is a read-write association end @@ -125,6 +142,11 @@ void QUmlExceptionHandler::addExceptionType(QUmlClassifier *exceptionType) } } +/*! + Removes \a exceptionType from exceptionTypes. + + \sa exceptionTypes(), addExceptionType() + */ void QUmlExceptionHandler::removeExceptionType(QUmlClassifier *exceptionType) { // This is a read-write association end @@ -144,6 +166,9 @@ QUmlExecutableNode *QUmlExceptionHandler::handlerBody() const return _handlerBody; } +/*! + Adjusts handlerBody to \a handlerBody. + */ void QUmlExceptionHandler::setHandlerBody(QUmlExecutableNode *handlerBody) { // This is a read-write association end @@ -157,6 +182,10 @@ void QUmlExceptionHandler::setHandlerBody(QUmlExecutableNode *handlerBody) /*! The node protected by the handler. The handler is examined if an exception propagates to the outside of the node. + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlExecutableNode::handlers(). */ QUmlExecutableNode *QUmlExceptionHandler::protectedNode() const { @@ -165,6 +194,9 @@ QUmlExecutableNode *QUmlExceptionHandler::protectedNode() const return _protectedNode; } +/*! + Adjusts protectedNode to \a protectedNode. + */ void QUmlExceptionHandler::setProtectedNode(QUmlExecutableNode *protectedNode) { // This is a read-write association end diff --git a/src/uml/qumlexceptionhandler.h b/src/uml/qumlexceptionhandler.h index bff4ed8c..7e5e9bbc 100644 --- a/src/uml/qumlexceptionhandler.h +++ b/src/uml/qumlexceptionhandler.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -84,7 +82,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExceptionHandler) *) -QT_END_HEADER - #endif // QUMLEXCEPTIONHANDLER_H diff --git a/src/uml/qumlexecutablenode.cpp b/src/uml/qumlexecutablenode.cpp index 2e19a912..85d9c05a 100644 --- a/src/uml/qumlexecutablenode.cpp +++ b/src/uml/qumlexecutablenode.cpp @@ -65,11 +65,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief An executable node is an abstract class for activity nodes that may be executed. It is used as an attachment point for exception handlers.An executable node is an abstract class for activity nodes that may be executed. It is used as an attachment point for exception handlers. + + \b {QUmlExecutableNode is an abstract class.} */ + +/*! + Creates a new QUmlExecutableNode. +*/ QUmlExecutableNode::QUmlExecutableNode() { } +/*! + Returns a deep-copied clone of the QUmlExecutableNode. +*/ QModelingElement *QUmlExecutableNode::clone() const { QUmlExecutableNode *c = new QUmlExecutableNode; @@ -105,6 +114,12 @@ QModelingElement *QUmlExecutableNode::clone() const /*! A set of exception handlers that are examined if an uncaught exception propagates to the outer level of the executable node. + + \sa addHandler(), removeHandler() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlExceptionHandler::protectedNode(). */ const QSet<QUmlExceptionHandler *> QUmlExecutableNode::handlers() const { @@ -113,6 +128,11 @@ const QSet<QUmlExceptionHandler *> QUmlExecutableNode::handlers() const return _handlers; } +/*! + Adds \a handler to handlers. + + \sa handlers(), removeHandler() + */ void QUmlExecutableNode::addHandler(QUmlExceptionHandler *handler) { // This is a read-write association end @@ -133,6 +153,11 @@ void QUmlExecutableNode::addHandler(QUmlExceptionHandler *handler) } } +/*! + Removes \a handler from handlers. + + \sa handlers(), addHandler() + */ void QUmlExecutableNode::removeHandler(QUmlExceptionHandler *handler) { // This is a read-write association end diff --git a/src/uml/qumlexecutablenode.h b/src/uml/qumlexecutablenode.h index ed5c6b56..5e404879 100644 --- a/src/uml/qumlexecutablenode.h +++ b/src/uml/qumlexecutablenode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlActivityNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -73,7 +71,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExecutableNode) *) -QT_END_HEADER - #endif // QUMLEXECUTABLENODE_H diff --git a/src/uml/qumlexecutionenvironment.cpp b/src/uml/qumlexecutionenvironment.cpp index 1140495d..546437ad 100644 --- a/src/uml/qumlexecutionenvironment.cpp +++ b/src/uml/qumlexecutionenvironment.cpp @@ -89,6 +89,10 @@ QT_BEGIN_NAMESPACE \brief An execution environment is a node that offers an execution environment for specific types of components that are deployed on it in the form of executable artifacts. */ + +/*! + Creates a new QUmlExecutionEnvironment. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlExecutionEnvironment::QUmlExecutionEnvironment(bool createQModelingObject) : QUmlNode(false) { @@ -96,6 +100,9 @@ QUmlExecutionEnvironment::QUmlExecutionEnvironment(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlExecutionEnvironmentObject(this)); } +/*! + Returns a deep-copied clone of the QUmlExecutionEnvironment. +*/ QModelingElement *QUmlExecutionEnvironment::clone() const { QUmlExecutionEnvironment *c = new QUmlExecutionEnvironment; diff --git a/src/uml/qumlexecutionenvironment.h b/src/uml/qumlexecutionenvironment.h index 51ac800c..cd0553c0 100644 --- a/src/uml/qumlexecutionenvironment.h +++ b/src/uml/qumlexecutionenvironment.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExecutionEnvironment) *) -QT_END_HEADER - #endif // QUMLEXECUTIONENVIRONMENT_H diff --git a/src/uml/qumlexecutionoccurrencespecification.cpp b/src/uml/qumlexecutionoccurrencespecification.cpp index 4718136a..c785c50b 100644 --- a/src/uml/qumlexecutionoccurrencespecification.cpp +++ b/src/uml/qumlexecutionoccurrencespecification.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief An execution occurrence specification represents moments in time at which actions or behaviors start or finish. */ + +/*! + Creates a new QUmlExecutionOccurrenceSpecification. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlExecutionOccurrenceSpecification::QUmlExecutionOccurrenceSpecification(bool createQModelingObject) : QUmlOccurrenceSpecification(false), _execution(0) @@ -72,6 +76,9 @@ QUmlExecutionOccurrenceSpecification::QUmlExecutionOccurrenceSpecification(bool _qModelingObject = qobject_cast<QModelingObject *>(new QUmlExecutionOccurrenceSpecificationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlExecutionOccurrenceSpecification. +*/ QModelingElement *QUmlExecutionOccurrenceSpecification::clone() const { QUmlExecutionOccurrenceSpecification *c = new QUmlExecutionOccurrenceSpecification; @@ -112,6 +119,9 @@ QUmlExecutionSpecification *QUmlExecutionOccurrenceSpecification::execution() co return _execution; } +/*! + Adjusts execution to \a execution. + */ void QUmlExecutionOccurrenceSpecification::setExecution(QUmlExecutionSpecification *execution) { // This is a read-write association end diff --git a/src/uml/qumlexecutionoccurrencespecification.h b/src/uml/qumlexecutionoccurrencespecification.h index d6f3e76c..bc1cc8b1 100644 --- a/src/uml/qumlexecutionoccurrencespecification.h +++ b/src/uml/qumlexecutionoccurrencespecification.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlOccurrenceSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExecutionOccurrenceSpecification) *) -QT_END_HEADER - #endif // QUMLEXECUTIONOCCURRENCESPECIFICATION_H diff --git a/src/uml/qumlexecutionspecification.cpp b/src/uml/qumlexecutionspecification.cpp index f17e8e35..8739fdae 100644 --- a/src/uml/qumlexecutionspecification.cpp +++ b/src/uml/qumlexecutionspecification.cpp @@ -61,13 +61,22 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief An execution specification is a specification of the execution of a unit of behavior or action within the lifeline. The duration of an execution specification is represented by two cccurrence specifications, the start occurrence specification and the finish occurrence specification. + + \b {QUmlExecutionSpecification is an abstract class.} */ + +/*! + Creates a new QUmlExecutionSpecification. +*/ QUmlExecutionSpecification::QUmlExecutionSpecification() : _finish(0), _start(0) { } +/*! + Returns a deep-copied clone of the QUmlExecutionSpecification. +*/ QModelingElement *QUmlExecutionSpecification::clone() const { QUmlExecutionSpecification *c = new QUmlExecutionSpecification; @@ -106,6 +115,9 @@ QUmlOccurrenceSpecification *QUmlExecutionSpecification::finish() const return _finish; } +/*! + Adjusts finish to \a finish. + */ void QUmlExecutionSpecification::setFinish(QUmlOccurrenceSpecification *finish) { // This is a read-write association end @@ -127,6 +139,9 @@ QUmlOccurrenceSpecification *QUmlExecutionSpecification::start() const return _start; } +/*! + Adjusts start to \a start. + */ void QUmlExecutionSpecification::setStart(QUmlOccurrenceSpecification *start) { // This is a read-write association end diff --git a/src/uml/qumlexecutionspecification.h b/src/uml/qumlexecutionspecification.h index 703856a8..81a9bbcc 100644 --- a/src/uml/qumlexecutionspecification.h +++ b/src/uml/qumlexecutionspecification.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInteractionFragment> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExecutionSpecification) *) -QT_END_HEADER - #endif // QUMLEXECUTIONSPECIFICATION_H diff --git a/src/uml/qumlexpansionnode.cpp b/src/uml/qumlexpansionnode.cpp index b4820176..bcb0add4 100644 --- a/src/uml/qumlexpansionnode.cpp +++ b/src/uml/qumlexpansionnode.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief An expansion node is an object node used to indicate a flow across the boundary of an expansion region. A flow into a region contains a collection that is broken into its individual elements inside the region, which is executed once per element. A flow out of a region combines individual elements into a collection for use outside the region. */ + +/*! + Creates a new QUmlExpansionNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlExpansionNode::QUmlExpansionNode(bool createQModelingObject) : _regionAsInput(0), _regionAsOutput(0) @@ -81,6 +85,9 @@ QUmlExpansionNode::QUmlExpansionNode(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlExpansionNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlExpansionNode. +*/ QModelingElement *QUmlExpansionNode::clone() const { QUmlExpansionNode *c = new QUmlExpansionNode; @@ -128,6 +135,8 @@ QModelingElement *QUmlExpansionNode::clone() const /*! The expansion region for which the node is an input. + + \b {Opposite property(ies):} QUmlExpansionRegion::inputElements(). */ QUmlExpansionRegion *QUmlExpansionNode::regionAsInput() const { @@ -136,6 +145,9 @@ QUmlExpansionRegion *QUmlExpansionNode::regionAsInput() const return _regionAsInput; } +/*! + Adjusts regionAsInput to \a regionAsInput. + */ void QUmlExpansionNode::setRegionAsInput(QUmlExpansionRegion *regionAsInput) { // This is a read-write association end @@ -149,6 +161,8 @@ void QUmlExpansionNode::setRegionAsInput(QUmlExpansionRegion *regionAsInput) /*! The expansion region for which the node is an output. + + \b {Opposite property(ies):} QUmlExpansionRegion::outputElements(). */ QUmlExpansionRegion *QUmlExpansionNode::regionAsOutput() const { @@ -157,6 +171,9 @@ QUmlExpansionRegion *QUmlExpansionNode::regionAsOutput() const return _regionAsOutput; } +/*! + Adjusts regionAsOutput to \a regionAsOutput. + */ void QUmlExpansionNode::setRegionAsOutput(QUmlExpansionRegion *regionAsOutput) { // This is a read-write association end diff --git a/src/uml/qumlexpansionnode.h b/src/uml/qumlexpansionnode.h index b51e7ddb..5f0daeea 100644 --- a/src/uml/qumlexpansionnode.h +++ b/src/uml/qumlexpansionnode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlObjectNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExpansionNode) *) -QT_END_HEADER - #endif // QUMLEXPANSIONNODE_H diff --git a/src/uml/qumlexpansionregion.cpp b/src/uml/qumlexpansionregion.cpp index 13a3547f..9c0e1e71 100644 --- a/src/uml/qumlexpansionregion.cpp +++ b/src/uml/qumlexpansionregion.cpp @@ -76,6 +76,10 @@ QT_BEGIN_NAMESPACE \brief An expansion region is a structured activity region that executes multiple times corresponding to elements of an input collection. */ + +/*! + Creates a new QUmlExpansionRegion. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlExpansionRegion::QUmlExpansionRegion(bool createQModelingObject) : QUmlStructuredActivityNode(false), _mode(QtUml::ExpansionKindIterative) @@ -84,6 +88,9 @@ QUmlExpansionRegion::QUmlExpansionRegion(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlExpansionRegionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlExpansionRegion. +*/ QModelingElement *QUmlExpansionRegion::clone() const { QUmlExpansionRegion *c = new QUmlExpansionRegion; @@ -146,6 +153,10 @@ QModelingElement *QUmlExpansionRegion::clone() const /*! An object node that holds a separate element of the input collection during each of the multiple executions of the region. + + \sa addInputElement(), removeInputElement() + + \b {Opposite property(ies):} QUmlExpansionNode::regionAsInput(). */ const QSet<QUmlExpansionNode *> QUmlExpansionRegion::inputElements() const { @@ -154,6 +165,11 @@ const QSet<QUmlExpansionNode *> QUmlExpansionRegion::inputElements() const return _inputElements; } +/*! + Adds \a inputElement to inputElements. + + \sa inputElements(), removeInputElement() + */ void QUmlExpansionRegion::addInputElement(QUmlExpansionNode *inputElement) { // This is a read-write association end @@ -170,6 +186,11 @@ void QUmlExpansionRegion::addInputElement(QUmlExpansionNode *inputElement) } } +/*! + Removes \a inputElement from inputElements. + + \sa inputElements(), addInputElement() + */ void QUmlExpansionRegion::removeInputElement(QUmlExpansionNode *inputElement) { // This is a read-write association end @@ -194,6 +215,9 @@ QtUml::ExpansionKind QUmlExpansionRegion::mode() const return _mode; } +/*! + Adjusts mode to \a mode. + */ void QUmlExpansionRegion::setMode(QtUml::ExpansionKind mode) { // This is a read-write property @@ -206,6 +230,10 @@ void QUmlExpansionRegion::setMode(QtUml::ExpansionKind mode) /*! An object node that accepts a separate element of the output collection during each of the multiple executions of the region. The values are formed into a collection that is available when the execution of the region is complete. + + \sa addOutputElement(), removeOutputElement() + + \b {Opposite property(ies):} QUmlExpansionNode::regionAsOutput(). */ const QSet<QUmlExpansionNode *> QUmlExpansionRegion::outputElements() const { @@ -214,6 +242,11 @@ const QSet<QUmlExpansionNode *> QUmlExpansionRegion::outputElements() const return _outputElements; } +/*! + Adds \a outputElement to outputElements. + + \sa outputElements(), removeOutputElement() + */ void QUmlExpansionRegion::addOutputElement(QUmlExpansionNode *outputElement) { // This is a read-write association end @@ -230,6 +263,11 @@ void QUmlExpansionRegion::addOutputElement(QUmlExpansionNode *outputElement) } } +/*! + Removes \a outputElement from outputElements. + + \sa outputElements(), addOutputElement() + */ void QUmlExpansionRegion::removeOutputElement(QUmlExpansionNode *outputElement) { // This is a read-write association end diff --git a/src/uml/qumlexpansionregion.h b/src/uml/qumlexpansionregion.h index 29a703e5..d28e7ce1 100644 --- a/src/uml/qumlexpansionregion.h +++ b/src/uml/qumlexpansionregion.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -82,7 +80,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExpansionRegion) *) -QT_END_HEADER - #endif // QUMLEXPANSIONREGION_H diff --git a/src/uml/qumlexpression.cpp b/src/uml/qumlexpression.cpp index 7f5edc04..ff95a117 100644 --- a/src/uml/qumlexpression.cpp +++ b/src/uml/qumlexpression.cpp @@ -62,12 +62,19 @@ QT_BEGIN_NAMESPACE \brief An expression is a structured tree of symbols that denotes a (possibly empty) set of values when evaluated in a context.An expression represents a node in an expression tree, which may be non-terminal or terminal. It defines a symbol, and has a possibly empty sequence of operands which are value specifications. */ + +/*! + Creates a new QUmlExpression. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlExpression::QUmlExpression(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlExpressionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlExpression. +*/ QModelingElement *QUmlExpression::clone() const { QUmlExpression *c = new QUmlExpression; @@ -95,6 +102,10 @@ QModelingElement *QUmlExpression::clone() const /*! Specifies a sequence of operands. + + \sa addOperand(), removeOperand() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QList<QUmlValueSpecification *> QUmlExpression::operands() const { @@ -103,6 +114,11 @@ const QList<QUmlValueSpecification *> QUmlExpression::operands() const return _operands; } +/*! + Adds \a operand to operands. + + \sa operands(), removeOperand() + */ void QUmlExpression::addOperand(QUmlValueSpecification *operand) { // This is a read-write association end @@ -118,6 +134,11 @@ void QUmlExpression::addOperand(QUmlValueSpecification *operand) } } +/*! + Removes \a operand from operands. + + \sa operands(), addOperand() + */ void QUmlExpression::removeOperand(QUmlValueSpecification *operand) { // This is a read-write association end @@ -142,6 +163,9 @@ QString QUmlExpression::symbol() const return _symbol; } +/*! + Adjusts symbol to \a symbol. + */ void QUmlExpression::setSymbol(QString symbol) { // This is a read-write property diff --git a/src/uml/qumlexpression.h b/src/uml/qumlexpression.h index 0f9edbad..c233bdac 100644 --- a/src/uml/qumlexpression.h +++ b/src/uml/qumlexpression.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlValueSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -74,7 +72,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExpression) *) -QT_END_HEADER - #endif // QUMLEXPRESSION_H diff --git a/src/uml/qumlextend.cpp b/src/uml/qumlextend.cpp index 3dd89daf..edf13863 100644 --- a/src/uml/qumlextend.cpp +++ b/src/uml/qumlextend.cpp @@ -61,6 +61,10 @@ QT_BEGIN_NAMESPACE \brief A relationship from an extending use case to an extended use case that specifies how and when the behavior defined in the extending use case can be inserted into the behavior defined in the extended use case. */ + +/*! + Creates a new QUmlExtend. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlExtend::QUmlExtend(bool createQModelingObject) : _condition(0), _extendedCase(0), @@ -70,6 +74,9 @@ QUmlExtend::QUmlExtend(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlExtendObject(this)); } +/*! + Returns a deep-copied clone of the QUmlExtend. +*/ QModelingElement *QUmlExtend::clone() const { QUmlExtend *c = new QUmlExtend; @@ -96,6 +103,8 @@ QModelingElement *QUmlExtend::clone() const /*! References the condition that must hold when the first extension point is reached for the extension to take place. If no constraint is associated with the extend relationship, the extension is unconditional. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlConstraint *QUmlExtend::condition() const { @@ -104,6 +113,9 @@ QUmlConstraint *QUmlExtend::condition() const return _condition; } +/*! + Adjusts condition to \a condition. + */ void QUmlExtend::setCondition(QUmlConstraint *condition) { // This is a read-write association end @@ -126,6 +138,8 @@ void QUmlExtend::setCondition(QUmlConstraint *condition) /*! References the use case that is being extended. + + \b {Subsetted property(ies):} QUmlDirectedRelationship::targets(). */ QUmlUseCase *QUmlExtend::extendedCase() const { @@ -134,6 +148,9 @@ QUmlUseCase *QUmlExtend::extendedCase() const return _extendedCase; } +/*! + Adjusts extendedCase to \a extendedCase. + */ void QUmlExtend::setExtendedCase(QUmlUseCase *extendedCase) { // This is a read-write association end @@ -155,6 +172,10 @@ void QUmlExtend::setExtendedCase(QUmlUseCase *extendedCase) /*! References the use case that represents the extension and owns the extend relationship. + + \b {Subsetted property(ies):} QUmlDirectedRelationship::sources(), QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlUseCase::extends(). */ QUmlUseCase *QUmlExtend::extension() const { @@ -163,6 +184,9 @@ QUmlUseCase *QUmlExtend::extension() const return _extension; } +/*! + Adjusts extension to \a extension. + */ void QUmlExtend::setExtension(QUmlUseCase *extension) { // This is a read-write association end @@ -185,6 +209,8 @@ void QUmlExtend::setExtension(QUmlUseCase *extension) /*! An ordered list of extension points belonging to the extended use case, specifying where the respective behavioral fragments of the extending use case are to be inserted. The first fragment in the extending use case is associated with the first extension point in the list, the second fragment with the second point, and so on. (Note that, in most practical cases, the extending use case has just a single behavior fragment, so that the list of extension points is trivial.) + + \sa addExtensionLocation(), removeExtensionLocation() */ const QList<QUmlExtensionPoint *> QUmlExtend::extensionLocations() const { @@ -193,6 +219,11 @@ const QList<QUmlExtensionPoint *> QUmlExtend::extensionLocations() const return _extensionLocations; } +/*! + Adds \a extensionLocation to extensionLocations. + + \sa extensionLocations(), removeExtensionLocation() + */ void QUmlExtend::addExtensionLocation(QUmlExtensionPoint *extensionLocation) { // This is a read-write association end @@ -204,6 +235,11 @@ void QUmlExtend::addExtensionLocation(QUmlExtensionPoint *extensionLocation) } } +/*! + Removes \a extensionLocation from extensionLocations. + + \sa extensionLocations(), addExtensionLocation() + */ void QUmlExtend::removeExtensionLocation(QUmlExtensionPoint *extensionLocation) { // This is a read-write association end diff --git a/src/uml/qumlextend.h b/src/uml/qumlextend.h index 95e3de8f..49562f86 100644 --- a/src/uml/qumlextend.h +++ b/src/uml/qumlextend.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlDirectedRelationship> #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -85,7 +83,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExtend) *) -QT_END_HEADER - #endif // QUMLEXTEND_H diff --git a/src/uml/qumlextension.cpp b/src/uml/qumlextension.cpp index 9e67355d..3c70a1d4 100644 --- a/src/uml/qumlextension.cpp +++ b/src/uml/qumlextension.cpp @@ -81,6 +81,10 @@ QT_BEGIN_NAMESPACE \brief An extension is used to indicate that the properties of a metaclass are extended through a stereotype, and gives the ability to flexibly add (and later remove) stereotypes to classes. */ + +/*! + Creates a new QUmlExtension. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlExtension::QUmlExtension(bool createQModelingObject) : QUmlAssociation(false), _ownedEnd(0) @@ -89,6 +93,9 @@ QUmlExtension::QUmlExtension(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlExtensionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlExtension. +*/ QModelingElement *QUmlExtension::clone() const { QUmlExtension *c = new QUmlExtension; @@ -149,6 +156,8 @@ QModelingElement *QUmlExtension::clone() const /*! Indicates whether an instance of the extending stereotype must be created when an instance of the extended class is created. The attribute value is derived from the value of the lower property of the ExtensionEnd referenced by Extension::ownedEnd; a lower value of 1 means that isRequired is true, but otherwise it is false. Since the default value of ExtensionEnd::lower is 0, the default value of isRequired is false. + + \b {This is a read-only derived property.} */ bool QUmlExtension::isRequired() const { @@ -159,6 +168,9 @@ bool QUmlExtension::isRequired() const return bool(); } +/*! + Adjusts isRequired to \a isRequired. + */ void QUmlExtension::setRequired(bool isRequired) { // This is a read-only derived property @@ -173,6 +185,10 @@ void QUmlExtension::setRequired(bool isRequired) /*! References the Class that is extended through an Extension. The property is derived from the type of the memberEnd that is not the ownedEnd. + + \b {This is a read-only derived property.} + + \b {Opposite property(ies):} QUmlClass::extensions(). */ QUmlClass *QUmlExtension::metaclass() const { @@ -183,6 +199,9 @@ QUmlClass *QUmlExtension::metaclass() const return 0; } +/*! + Adjusts metaclass to \a metaclass. + */ void QUmlExtension::setMetaclass(QUmlClass *metaclass) { // This is a read-only derived association end @@ -197,6 +216,8 @@ void QUmlExtension::setMetaclass(QUmlClass *metaclass) /*! References the end of the extension that is typed by a Stereotype. + + \b {Redefined property(ies):} QUmlAssociation::ownedEnds(). */ QUmlExtensionEnd *QUmlExtension::ownedEnd() const { @@ -205,6 +226,9 @@ QUmlExtensionEnd *QUmlExtension::ownedEnd() const return _ownedEnd; } +/*! + Adjusts ownedEnd to \a ownedEnd. + */ void QUmlExtension::setOwnedEnd(QUmlExtensionEnd *ownedEnd) { // This is a read-write association end diff --git a/src/uml/qumlextension.h b/src/uml/qumlextension.h index f622c86b..985e7ca1 100644 --- a/src/uml/qumlextension.h +++ b/src/uml/qumlextension.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAssociation> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExtension) *) -QT_END_HEADER - #endif // QUMLEXTENSION_H diff --git a/src/uml/qumlextensionend.cpp b/src/uml/qumlextensionend.cpp index ec5658e9..0544957b 100644 --- a/src/uml/qumlextensionend.cpp +++ b/src/uml/qumlextensionend.cpp @@ -75,6 +75,10 @@ QT_BEGIN_NAMESPACE \brief An extension end is used to tie an extension to a stereotype when extending a metaclass.The default multiplicity of an extension end is 0..1. */ + +/*! + Creates a new QUmlExtensionEnd. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlExtensionEnd::QUmlExtensionEnd(bool createQModelingObject) : QUmlProperty(false), _type(0) @@ -83,6 +87,9 @@ QUmlExtensionEnd::QUmlExtensionEnd(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlExtensionEndObject(this)); } +/*! + Returns a deep-copied clone of the QUmlExtensionEnd. +*/ QModelingElement *QUmlExtensionEnd::clone() const { QUmlExtensionEnd *c = new QUmlExtensionEnd; @@ -142,6 +149,10 @@ QModelingElement *QUmlExtensionEnd::clone() const /*! This redefinition changes the default multiplicity of association ends, since model elements are usually extended by 0 or 1 instance of the extension stereotype. + + \b {This is a derived property.} + + \b {Redefined property(ies):} QUmlMultiplicityElement::lower(). */ int QUmlExtensionEnd::lower() const { @@ -152,6 +163,9 @@ int QUmlExtensionEnd::lower() const return int(); } +/*! + Adjusts lower to \a lower. + */ void QUmlExtensionEnd::setLower(int lower) { // This is a read-write derived property @@ -169,6 +183,8 @@ void QUmlExtensionEnd::setLower(int lower) /*! References the type of the ExtensionEnd. Note that this association restricts the possible types of an ExtensionEnd to only be Stereotypes. + + \b {Redefined property(ies):} QUmlTypedElement::type(). */ QUmlStereotype *QUmlExtensionEnd::type() const { @@ -177,6 +193,9 @@ QUmlStereotype *QUmlExtensionEnd::type() const return _type; } +/*! + Adjusts type to \a type. + */ void QUmlExtensionEnd::setType(QUmlStereotype *type) { // This is a read-write association end diff --git a/src/uml/qumlextensionend.h b/src/uml/qumlextensionend.h index 3f3bd71e..439eadb0 100644 --- a/src/uml/qumlextensionend.h +++ b/src/uml/qumlextensionend.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlProperty> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -77,7 +75,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExtensionEnd) *) -QT_END_HEADER - #endif // QUMLEXTENSIONEND_H diff --git a/src/uml/qumlextensionpoint.cpp b/src/uml/qumlextensionpoint.cpp index 18a4451a..dca6d648 100644 --- a/src/uml/qumlextensionpoint.cpp +++ b/src/uml/qumlextensionpoint.cpp @@ -61,6 +61,10 @@ QT_BEGIN_NAMESPACE \brief An extension point identifies a point in the behavior of a use case where that behavior can be extended by the behavior of some other (extending) use case, as specified by an extend relationship. */ + +/*! + Creates a new QUmlExtensionPoint. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlExtensionPoint::QUmlExtensionPoint(bool createQModelingObject) : _useCase(0) { @@ -68,6 +72,9 @@ QUmlExtensionPoint::QUmlExtensionPoint(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlExtensionPointObject(this)); } +/*! + Returns a deep-copied clone of the QUmlExtensionPoint. +*/ QModelingElement *QUmlExtensionPoint::clone() const { QUmlExtensionPoint *c = new QUmlExtensionPoint; @@ -89,6 +96,10 @@ QModelingElement *QUmlExtensionPoint::clone() const /*! References the use case that owns this extension point. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlUseCase::extensionPoints(). */ QUmlUseCase *QUmlExtensionPoint::useCase() const { @@ -97,6 +108,9 @@ QUmlUseCase *QUmlExtensionPoint::useCase() const return _useCase; } +/*! + Adjusts useCase to \a useCase. + */ void QUmlExtensionPoint::setUseCase(QUmlUseCase *useCase) { // This is a read-write association end diff --git a/src/uml/qumlextensionpoint.h b/src/uml/qumlextensionpoint.h index e7537ea4..ffc424b7 100644 --- a/src/uml/qumlextensionpoint.h +++ b/src/uml/qumlextensionpoint.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlRedefinableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlExtensionPoint) *) -QT_END_HEADER - #endif // QUMLEXTENSIONPOINT_H diff --git a/src/uml/qumlfeature.cpp b/src/uml/qumlfeature.cpp index 49867a66..811192da 100644 --- a/src/uml/qumlfeature.cpp +++ b/src/uml/qumlfeature.cpp @@ -57,12 +57,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A feature declares a behavioral or structural characteristic of instances of classifiers. + + \b {QUmlFeature is an abstract class.} */ + +/*! + Creates a new QUmlFeature. +*/ QUmlFeature::QUmlFeature() : _isStatic(false) { } +/*! + Returns a deep-copied clone of the QUmlFeature. +*/ QModelingElement *QUmlFeature::clone() const { QUmlFeature *c = new QUmlFeature; @@ -83,6 +92,12 @@ QModelingElement *QUmlFeature::clone() const /*! The Classifiers that have this Feature as a feature. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} . + + \b {Opposite property(ies):} QUmlClassifier::features(). */ const QSet<QUmlClassifier *> QUmlFeature::featuringClassifiers() const { @@ -91,6 +106,11 @@ const QSet<QUmlClassifier *> QUmlFeature::featuringClassifiers() const return _featuringClassifiers; } +/*! + Adds \a featuringClassifier to featuringClassifiers. + + \sa featuringClassifiers(), removeFeaturingClassifier() + */ void QUmlFeature::addFeaturingClassifier(QUmlClassifier *featuringClassifier) { // This is a read-only derived union association end @@ -107,6 +127,11 @@ void QUmlFeature::addFeaturingClassifier(QUmlClassifier *featuringClassifier) } } +/*! + Removes \a featuringClassifier from featuringClassifiers. + + \sa featuringClassifiers(), addFeaturingClassifier() + */ void QUmlFeature::removeFeaturingClassifier(QUmlClassifier *featuringClassifier) { // This is a read-only derived union association end @@ -131,6 +156,9 @@ bool QUmlFeature::isStatic() const return _isStatic; } +/*! + Adjusts isStatic to \a isStatic. + */ void QUmlFeature::setStatic(bool isStatic) { // This is a read-write property diff --git a/src/uml/qumlfeature.h b/src/uml/qumlfeature.h index 433cab70..7b7123f2 100644 --- a/src/uml/qumlfeature.h +++ b/src/uml/qumlfeature.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlRedefinableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlFeature) *) -QT_END_HEADER - #endif // QUMLFEATURE_H diff --git a/src/uml/qumlfinalnode.cpp b/src/uml/qumlfinalnode.cpp index 3621f591..0e741ae8 100644 --- a/src/uml/qumlfinalnode.cpp +++ b/src/uml/qumlfinalnode.cpp @@ -65,11 +65,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A final node is an abstract control node at which a flow in an activity stops. + + \b {QUmlFinalNode is an abstract class.} */ + +/*! + Creates a new QUmlFinalNode. +*/ QUmlFinalNode::QUmlFinalNode() { } +/*! + Returns a deep-copied clone of the QUmlFinalNode. +*/ QModelingElement *QUmlFinalNode::clone() const { QUmlFinalNode *c = new QUmlFinalNode; diff --git a/src/uml/qumlfinalnode.h b/src/uml/qumlfinalnode.h index f91602cf..7d3d8bc7 100644 --- a/src/uml/qumlfinalnode.h +++ b/src/uml/qumlfinalnode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlControlNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlFinalNode) *) -QT_END_HEADER - #endif // QUMLFINALNODE_H diff --git a/src/uml/qumlfinalstate.cpp b/src/uml/qumlfinalstate.cpp index 8d09e589..b51d3512 100644 --- a/src/uml/qumlfinalstate.cpp +++ b/src/uml/qumlfinalstate.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief A special kind of state signifying that the enclosing region is completed. If the enclosing region is directly contained in a state machine and all other regions in the state machine also are completed, then it means that the entire state machine is completed. */ + +/*! + Creates a new QUmlFinalState. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlFinalState::QUmlFinalState(bool createQModelingObject) : QUmlState(false) { @@ -79,6 +83,9 @@ QUmlFinalState::QUmlFinalState(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlFinalStateObject(this)); } +/*! + Returns a deep-copied clone of the QUmlFinalState. +*/ QModelingElement *QUmlFinalState::clone() const { QUmlFinalState *c = new QUmlFinalState; diff --git a/src/uml/qumlfinalstate.h b/src/uml/qumlfinalstate.h index ff70b0f8..58e30db8 100644 --- a/src/uml/qumlfinalstate.h +++ b/src/uml/qumlfinalstate.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlState> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlFinalState) *) -QT_END_HEADER - #endif // QUMLFINALSTATE_H diff --git a/src/uml/qumlflowfinalnode.cpp b/src/uml/qumlflowfinalnode.cpp index 9eb0c0a9..018af087 100644 --- a/src/uml/qumlflowfinalnode.cpp +++ b/src/uml/qumlflowfinalnode.cpp @@ -68,12 +68,19 @@ QT_BEGIN_NAMESPACE \brief A flow final node is a final node that terminates a flow. */ + +/*! + Creates a new QUmlFlowFinalNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlFlowFinalNode::QUmlFlowFinalNode(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlFlowFinalNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlFlowFinalNode. +*/ QModelingElement *QUmlFlowFinalNode::clone() const { QUmlFlowFinalNode *c = new QUmlFlowFinalNode; diff --git a/src/uml/qumlflowfinalnode.h b/src/uml/qumlflowfinalnode.h index a380361e..5599f079 100644 --- a/src/uml/qumlflowfinalnode.h +++ b/src/uml/qumlflowfinalnode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlFinalNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlFlowFinalNode) *) -QT_END_HEADER - #endif // QUMLFLOWFINALNODE_H diff --git a/src/uml/qumlforknode.cpp b/src/uml/qumlforknode.cpp index 1dda4309..aa889a61 100644 --- a/src/uml/qumlforknode.cpp +++ b/src/uml/qumlforknode.cpp @@ -68,12 +68,19 @@ QT_BEGIN_NAMESPACE \brief A fork node is a control node that splits a flow into multiple concurrent flows. */ + +/*! + Creates a new QUmlForkNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlForkNode::QUmlForkNode(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlForkNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlForkNode. +*/ QModelingElement *QUmlForkNode::clone() const { QUmlForkNode *c = new QUmlForkNode; diff --git a/src/uml/qumlforknode.h b/src/uml/qumlforknode.h index 3bb29faa..de3e0b97 100644 --- a/src/uml/qumlforknode.h +++ b/src/uml/qumlforknode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlControlNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlForkNode) *) -QT_END_HEADER - #endif // QUMLFORKNODE_H diff --git a/src/uml/qumlfunctionbehavior.cpp b/src/uml/qumlfunctionbehavior.cpp index 471408d4..2cc16403 100644 --- a/src/uml/qumlfunctionbehavior.cpp +++ b/src/uml/qumlfunctionbehavior.cpp @@ -92,6 +92,10 @@ QT_BEGIN_NAMESPACE \brief A function behavior is an opaque behavior that does not access or modify any objects or other external data. */ + +/*! + Creates a new QUmlFunctionBehavior. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlFunctionBehavior::QUmlFunctionBehavior(bool createQModelingObject) : QUmlOpaqueBehavior(false) { @@ -99,6 +103,9 @@ QUmlFunctionBehavior::QUmlFunctionBehavior(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlFunctionBehaviorObject(this)); } +/*! + Returns a deep-copied clone of the QUmlFunctionBehavior. +*/ QModelingElement *QUmlFunctionBehavior::clone() const { QUmlFunctionBehavior *c = new QUmlFunctionBehavior; diff --git a/src/uml/qumlfunctionbehavior.h b/src/uml/qumlfunctionbehavior.h index 19686d97..973b4473 100644 --- a/src/uml/qumlfunctionbehavior.h +++ b/src/uml/qumlfunctionbehavior.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlOpaqueBehavior> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlFunctionBehavior) *) -QT_END_HEADER - #endif // QUMLFUNCTIONBEHAVIOR_H diff --git a/src/uml/qumlgate.cpp b/src/uml/qumlgate.cpp index 33df2584..051eed93 100644 --- a/src/uml/qumlgate.cpp +++ b/src/uml/qumlgate.cpp @@ -60,12 +60,19 @@ QT_BEGIN_NAMESPACE \brief A gate is a connection point for relating a message outside an interaction fragment with a message inside the interaction fragment. */ + +/*! + Creates a new QUmlGate. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlGate::QUmlGate(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlGateObject(this)); } +/*! + Returns a deep-copied clone of the QUmlGate. +*/ QModelingElement *QUmlGate::clone() const { QUmlGate *c = new QUmlGate; diff --git a/src/uml/qumlgate.h b/src/uml/qumlgate.h index 8e67eb3b..d02d6307 100644 --- a/src/uml/qumlgate.h +++ b/src/uml/qumlgate.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlMessageEnd> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlGate) *) -QT_END_HEADER - #endif // QUMLGATE_H diff --git a/src/uml/qumlgeneralization.cpp b/src/uml/qumlgeneralization.cpp index 1a639be2..d537587a 100644 --- a/src/uml/qumlgeneralization.cpp +++ b/src/uml/qumlgeneralization.cpp @@ -56,6 +56,10 @@ QT_BEGIN_NAMESPACE \brief A generalization is a taxonomic relationship between a more general classifier and a more specific classifier. Each instance of the specific classifier is also an indirect instance of the general classifier. Thus, the specific classifier inherits the features of the more general classifier.A generalization relates a specific classifier to a more general classifier, and is owned by the specific classifier. */ + +/*! + Creates a new QUmlGeneralization. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlGeneralization::QUmlGeneralization(bool createQModelingObject) : _general(0), _isSubstitutable(true), @@ -65,6 +69,9 @@ QUmlGeneralization::QUmlGeneralization(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlGeneralizationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlGeneralization. +*/ QModelingElement *QUmlGeneralization::clone() const { QUmlGeneralization *c = new QUmlGeneralization; @@ -84,6 +91,8 @@ QModelingElement *QUmlGeneralization::clone() const /*! References the general classifier in the Generalization relationship. + + \b {Subsetted property(ies):} QUmlDirectedRelationship::targets(). */ QUmlClassifier *QUmlGeneralization::general() const { @@ -92,6 +101,9 @@ QUmlClassifier *QUmlGeneralization::general() const return _general; } +/*! + Adjusts general to \a general. + */ void QUmlGeneralization::setGeneral(QUmlClassifier *general) { // This is a read-write association end @@ -113,6 +125,10 @@ void QUmlGeneralization::setGeneral(QUmlClassifier *general) /*! Designates a set in which instances of Generalization is considered members. + + \sa addGeneralizationSet(), removeGeneralizationSet() + + \b {Opposite property(ies):} QUmlGeneralizationSet::generalizations(). */ const QSet<QUmlGeneralizationSet *> QUmlGeneralization::generalizationSets() const { @@ -121,6 +137,11 @@ const QSet<QUmlGeneralizationSet *> QUmlGeneralization::generalizationSets() con return _generalizationSets; } +/*! + Adds \a generalizationSet to generalizationSets. + + \sa generalizationSets(), removeGeneralizationSet() + */ void QUmlGeneralization::addGeneralizationSet(QUmlGeneralizationSet *generalizationSet) { // This is a read-write association end @@ -137,6 +158,11 @@ void QUmlGeneralization::addGeneralizationSet(QUmlGeneralizationSet *generalizat } } +/*! + Removes \a generalizationSet from generalizationSets. + + \sa generalizationSets(), addGeneralizationSet() + */ void QUmlGeneralization::removeGeneralizationSet(QUmlGeneralizationSet *generalizationSet) { // This is a read-write association end @@ -161,6 +187,9 @@ bool QUmlGeneralization::isSubstitutable() const return _isSubstitutable; } +/*! + Adjusts isSubstitutable to \a isSubstitutable. + */ void QUmlGeneralization::setSubstitutable(bool isSubstitutable) { // This is a read-write property @@ -173,6 +202,10 @@ void QUmlGeneralization::setSubstitutable(bool isSubstitutable) /*! References the specializing classifier in the Generalization relationship. + + \b {Subsetted property(ies):} QUmlElement::owner(), QUmlDirectedRelationship::sources(). + + \b {Opposite property(ies):} QUmlClassifier::generalizations(). */ QUmlClassifier *QUmlGeneralization::specific() const { @@ -181,6 +214,9 @@ QUmlClassifier *QUmlGeneralization::specific() const return _specific; } +/*! + Adjusts specific to \a specific. + */ void QUmlGeneralization::setSpecific(QUmlClassifier *specific) { // This is a read-write association end diff --git a/src/uml/qumlgeneralization.h b/src/uml/qumlgeneralization.h index 38220755..817355e8 100644 --- a/src/uml/qumlgeneralization.h +++ b/src/uml/qumlgeneralization.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlDirectedRelationship> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -83,7 +81,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlGeneralization) *) -QT_END_HEADER - #endif // QUMLGENERALIZATION_H diff --git a/src/uml/qumlgeneralizationset.cpp b/src/uml/qumlgeneralizationset.cpp index 4888fa14..73d20e71 100644 --- a/src/uml/qumlgeneralizationset.cpp +++ b/src/uml/qumlgeneralizationset.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief A generalization set is a packageable element whose instances define collections of subsets of generalization relationships. */ + +/*! + Creates a new QUmlGeneralizationSet. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlGeneralizationSet::QUmlGeneralizationSet(bool createQModelingObject) : _isCovering(false), _isDisjoint(false), @@ -72,6 +76,9 @@ QUmlGeneralizationSet::QUmlGeneralizationSet(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlGeneralizationSetObject(this)); } +/*! + Returns a deep-copied clone of the QUmlGeneralizationSet. +*/ QModelingElement *QUmlGeneralizationSet::clone() const { QUmlGeneralizationSet *c = new QUmlGeneralizationSet; @@ -100,6 +107,10 @@ QModelingElement *QUmlGeneralizationSet::clone() const /*! Designates the instances of Generalization which are members of a given GeneralizationSet. + + \sa addGeneralization(), removeGeneralization() + + \b {Opposite property(ies):} QUmlGeneralization::generalizationSets(). */ const QSet<QUmlGeneralization *> QUmlGeneralizationSet::generalizations() const { @@ -108,6 +119,11 @@ const QSet<QUmlGeneralization *> QUmlGeneralizationSet::generalizations() const return _generalizations; } +/*! + Adds \a generalization to generalizations. + + \sa generalizations(), removeGeneralization() + */ void QUmlGeneralizationSet::addGeneralization(QUmlGeneralization *generalization) { // This is a read-write association end @@ -124,6 +140,11 @@ void QUmlGeneralizationSet::addGeneralization(QUmlGeneralization *generalization } } +/*! + Removes \a generalization from generalizations. + + \sa generalizations(), addGeneralization() + */ void QUmlGeneralizationSet::removeGeneralization(QUmlGeneralization *generalization) { // This is a read-write association end @@ -148,6 +169,9 @@ bool QUmlGeneralizationSet::isCovering() const return _isCovering; } +/*! + Adjusts isCovering to \a isCovering. + */ void QUmlGeneralizationSet::setCovering(bool isCovering) { // This is a read-write property @@ -168,6 +192,9 @@ bool QUmlGeneralizationSet::isDisjoint() const return _isDisjoint; } +/*! + Adjusts isDisjoint to \a isDisjoint. + */ void QUmlGeneralizationSet::setDisjoint(bool isDisjoint) { // This is a read-write property @@ -180,6 +207,8 @@ void QUmlGeneralizationSet::setDisjoint(bool isDisjoint) /*! Designates the Classifier that is defined as the power type for the associated GeneralizationSet. + + \b {Opposite property(ies):} QUmlClassifier::powertypeExtents(). */ QUmlClassifier *QUmlGeneralizationSet::powertype() const { @@ -188,6 +217,9 @@ QUmlClassifier *QUmlGeneralizationSet::powertype() const return _powertype; } +/*! + Adjusts powertype to \a powertype. + */ void QUmlGeneralizationSet::setPowertype(QUmlClassifier *powertype) { // This is a read-write association end diff --git a/src/uml/qumlgeneralizationset.h b/src/uml/qumlgeneralizationset.h index 13d5414c..2772fb47 100644 --- a/src/uml/qumlgeneralizationset.h +++ b/src/uml/qumlgeneralizationset.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlPackageableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -83,7 +81,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlGeneralizationSet) *) -QT_END_HEADER - #endif // QUMLGENERALIZATIONSET_H diff --git a/src/uml/qumlgeneralordering.cpp b/src/uml/qumlgeneralordering.cpp index 60bf9c4e..b35066e3 100644 --- a/src/uml/qumlgeneralordering.cpp +++ b/src/uml/qumlgeneralordering.cpp @@ -59,6 +59,10 @@ QT_BEGIN_NAMESPACE \brief A general ordering represents a binary relation between two occurrence specifications, to describe that one occurrence specification must occur before the other in a valid trace. This mechanism provides the ability to define partial orders of occurrence cpecifications that may otherwise not have a specified order. */ + +/*! + Creates a new QUmlGeneralOrdering. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlGeneralOrdering::QUmlGeneralOrdering(bool createQModelingObject) : _after(0), _before(0) @@ -67,6 +71,9 @@ QUmlGeneralOrdering::QUmlGeneralOrdering(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlGeneralOrderingObject(this)); } +/*! + Returns a deep-copied clone of the QUmlGeneralOrdering. +*/ QModelingElement *QUmlGeneralOrdering::clone() const { QUmlGeneralOrdering *c = new QUmlGeneralOrdering; @@ -89,6 +96,8 @@ QModelingElement *QUmlGeneralOrdering::clone() const /*! The OccurrenceSpecification referenced comes after the OccurrenceSpecification referenced by before. + + \b {Opposite property(ies):} QUmlOccurrenceSpecification::toBefores(). */ QUmlOccurrenceSpecification *QUmlGeneralOrdering::after() const { @@ -97,6 +106,9 @@ QUmlOccurrenceSpecification *QUmlGeneralOrdering::after() const return _after; } +/*! + Adjusts after to \a after. + */ void QUmlGeneralOrdering::setAfter(QUmlOccurrenceSpecification *after) { // This is a read-write association end @@ -110,6 +122,8 @@ void QUmlGeneralOrdering::setAfter(QUmlOccurrenceSpecification *after) /*! The OccurrenceSpecification referenced comes before the OccurrenceSpecification referenced by after. + + \b {Opposite property(ies):} QUmlOccurrenceSpecification::toAfters(). */ QUmlOccurrenceSpecification *QUmlGeneralOrdering::before() const { @@ -118,6 +132,9 @@ QUmlOccurrenceSpecification *QUmlGeneralOrdering::before() const return _before; } +/*! + Adjusts before to \a before. + */ void QUmlGeneralOrdering::setBefore(QUmlOccurrenceSpecification *before) { // This is a read-write association end diff --git a/src/uml/qumlgeneralordering.h b/src/uml/qumlgeneralordering.h index 2ebeb1ba..e3c320b9 100644 --- a/src/uml/qumlgeneralordering.h +++ b/src/uml/qumlgeneralordering.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlGeneralOrdering) *) -QT_END_HEADER - #endif // QUMLGENERALORDERING_H diff --git a/src/uml/qumlimage.cpp b/src/uml/qumlimage.cpp index 72c4f5c3..df6a4ae4 100644 --- a/src/uml/qumlimage.cpp +++ b/src/uml/qumlimage.cpp @@ -53,12 +53,19 @@ QT_BEGIN_NAMESPACE \brief Physical definition of a graphical image. */ + +/*! + Creates a new QUmlImage. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlImage::QUmlImage(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlImageObject(this)); } +/*! + Returns a deep-copied clone of the QUmlImage. +*/ QModelingElement *QUmlImage::clone() const { QUmlImage *c = new QUmlImage; @@ -82,6 +89,9 @@ QString QUmlImage::content() const return _content; } +/*! + Adjusts content to \a content. + */ void QUmlImage::setContent(QString content) { // This is a read-write property @@ -101,6 +111,9 @@ QString QUmlImage::format() const return _format; } +/*! + Adjusts format to \a format. + */ void QUmlImage::setFormat(QString format) { // This is a read-write property @@ -120,6 +133,9 @@ QString QUmlImage::location() const return _location; } +/*! + Adjusts location to \a location. + */ void QUmlImage::setLocation(QString location) { // This is a read-write property diff --git a/src/uml/qumlimage.h b/src/uml/qumlimage.h index bfba03df..2606b4c4 100644 --- a/src/uml/qumlimage.h +++ b/src/uml/qumlimage.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlImage) *) -QT_END_HEADER - #endif // QUMLIMAGE_H diff --git a/src/uml/qumlinclude.cpp b/src/uml/qumlinclude.cpp index cd912a14..eda37cb2 100644 --- a/src/uml/qumlinclude.cpp +++ b/src/uml/qumlinclude.cpp @@ -59,6 +59,10 @@ QT_BEGIN_NAMESPACE \brief An include relationship defines that a use case contains the behavior defined in another use case. */ + +/*! + Creates a new QUmlInclude. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInclude::QUmlInclude(bool createQModelingObject) : _addition(0), _includingCase(0) @@ -67,6 +71,9 @@ QUmlInclude::QUmlInclude(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlIncludeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInclude. +*/ QModelingElement *QUmlInclude::clone() const { QUmlInclude *c = new QUmlInclude; @@ -89,6 +96,8 @@ QModelingElement *QUmlInclude::clone() const /*! References the use case that is to be included. + + \b {Subsetted property(ies):} QUmlDirectedRelationship::targets(). */ QUmlUseCase *QUmlInclude::addition() const { @@ -97,6 +106,9 @@ QUmlUseCase *QUmlInclude::addition() const return _addition; } +/*! + Adjusts addition to \a addition. + */ void QUmlInclude::setAddition(QUmlUseCase *addition) { // This is a read-write association end @@ -118,6 +130,10 @@ void QUmlInclude::setAddition(QUmlUseCase *addition) /*! References the use case which will include the addition and owns the include relationship. + + \b {Subsetted property(ies):} QUmlDirectedRelationship::sources(), QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlUseCase::includes(). */ QUmlUseCase *QUmlInclude::includingCase() const { @@ -126,6 +142,9 @@ QUmlUseCase *QUmlInclude::includingCase() const return _includingCase; } +/*! + Adjusts includingCase to \a includingCase. + */ void QUmlInclude::setIncludingCase(QUmlUseCase *includingCase) { // This is a read-write association end diff --git a/src/uml/qumlinclude.h b/src/uml/qumlinclude.h index 8d34a9a3..a296ec30 100644 --- a/src/uml/qumlinclude.h +++ b/src/uml/qumlinclude.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlDirectedRelationship> #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInclude) *) -QT_END_HEADER - #endif // QUMLINCLUDE_H diff --git a/src/uml/qumlinformationflow.cpp b/src/uml/qumlinformationflow.cpp index a4882a62..57d1bc98 100644 --- a/src/uml/qumlinformationflow.cpp +++ b/src/uml/qumlinformationflow.cpp @@ -66,12 +66,19 @@ QT_BEGIN_NAMESPACE \brief An information flow specifies that one or more information items circulates from its sources to its targets. Information flows require some kind of information channel for transmitting information items from the source to the destination. An information channel is represented in various ways depending on the nature of its sources and targets. It may be represented by connectors, links, associations, or even dependencies. For example, if the source and destination are parts in some composite structure such as a collaboration, then the information channel is likely to be represented by a connector between them. Or, if the source and target are objects (which are a kind of instance specification), they may be represented by a link that joins the two, and so on. */ + +/*! + Creates a new QUmlInformationFlow. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInformationFlow::QUmlInformationFlow(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInformationFlowObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInformationFlow. +*/ QModelingElement *QUmlInformationFlow::clone() const { QUmlInformationFlow *c = new QUmlInformationFlow; @@ -108,6 +115,8 @@ QModelingElement *QUmlInformationFlow::clone() const /*! Specifies the information items that may circulate on this information flow. + + \sa addConveyed(), removeConveyed() */ const QSet<QUmlClassifier *> QUmlInformationFlow::conveyed() const { @@ -116,6 +125,11 @@ const QSet<QUmlClassifier *> QUmlInformationFlow::conveyed() const return _conveyed; } +/*! + Adds \a conveyed to conveyed. + + \sa conveyed(), removeConveyed() + */ void QUmlInformationFlow::addConveyed(QUmlClassifier *conveyed) { // This is a read-write association end @@ -127,6 +141,11 @@ void QUmlInformationFlow::addConveyed(QUmlClassifier *conveyed) } } +/*! + Removes \a conveyed from conveyed. + + \sa conveyed(), addConveyed() + */ void QUmlInformationFlow::removeConveyed(QUmlClassifier *conveyed) { // This is a read-write association end @@ -138,6 +157,10 @@ void QUmlInformationFlow::removeConveyed(QUmlClassifier *conveyed) /*! Defines from which source the conveyed InformationItems are initiated. + + \sa addInformationSource(), removeInformationSource() + + \b {Subsetted property(ies):} QUmlDirectedRelationship::sources(). */ const QSet<QUmlNamedElement *> QUmlInformationFlow::informationSources() const { @@ -146,6 +169,11 @@ const QSet<QUmlNamedElement *> QUmlInformationFlow::informationSources() const return _informationSources; } +/*! + Adds \a informationSource to informationSources. + + \sa informationSources(), removeInformationSource() + */ void QUmlInformationFlow::addInformationSource(QUmlNamedElement *informationSource) { // This is a read-write association end @@ -160,6 +188,11 @@ void QUmlInformationFlow::addInformationSource(QUmlNamedElement *informationSour } } +/*! + Removes \a informationSource from informationSources. + + \sa informationSources(), addInformationSource() + */ void QUmlInformationFlow::removeInformationSource(QUmlNamedElement *informationSource) { // This is a read-write association end @@ -174,6 +207,10 @@ void QUmlInformationFlow::removeInformationSource(QUmlNamedElement *informationS /*! Defines to which target the conveyed InformationItems are directed. + + \sa addInformationTarget(), removeInformationTarget() + + \b {Subsetted property(ies):} QUmlDirectedRelationship::targets(). */ const QSet<QUmlNamedElement *> QUmlInformationFlow::informationTargets() const { @@ -182,6 +219,11 @@ const QSet<QUmlNamedElement *> QUmlInformationFlow::informationTargets() const return _informationTargets; } +/*! + Adds \a informationTarget to informationTargets. + + \sa informationTargets(), removeInformationTarget() + */ void QUmlInformationFlow::addInformationTarget(QUmlNamedElement *informationTarget) { // This is a read-write association end @@ -196,6 +238,11 @@ void QUmlInformationFlow::addInformationTarget(QUmlNamedElement *informationTarg } } +/*! + Removes \a informationTarget from informationTargets. + + \sa informationTargets(), addInformationTarget() + */ void QUmlInformationFlow::removeInformationTarget(QUmlNamedElement *informationTarget) { // This is a read-write association end @@ -210,6 +257,8 @@ void QUmlInformationFlow::removeInformationTarget(QUmlNamedElement *informationT /*! Determines which Relationship will realize the specified flow + + \sa addRealization(), removeRealization() */ const QSet<QUmlRelationship *> QUmlInformationFlow::realizations() const { @@ -218,6 +267,11 @@ const QSet<QUmlRelationship *> QUmlInformationFlow::realizations() const return _realizations; } +/*! + Adds \a realization to realizations. + + \sa realizations(), removeRealization() + */ void QUmlInformationFlow::addRealization(QUmlRelationship *realization) { // This is a read-write association end @@ -229,6 +283,11 @@ void QUmlInformationFlow::addRealization(QUmlRelationship *realization) } } +/*! + Removes \a realization from realizations. + + \sa realizations(), addRealization() + */ void QUmlInformationFlow::removeRealization(QUmlRelationship *realization) { // This is a read-write association end @@ -240,6 +299,8 @@ void QUmlInformationFlow::removeRealization(QUmlRelationship *realization) /*! Determines which ActivityEdges will realize the specified flow. + + \sa addRealizingActivityEdge(), removeRealizingActivityEdge() */ const QSet<QUmlActivityEdge *> QUmlInformationFlow::realizingActivityEdges() const { @@ -248,6 +309,11 @@ const QSet<QUmlActivityEdge *> QUmlInformationFlow::realizingActivityEdges() con return _realizingActivityEdges; } +/*! + Adds \a realizingActivityEdge to realizingActivityEdges. + + \sa realizingActivityEdges(), removeRealizingActivityEdge() + */ void QUmlInformationFlow::addRealizingActivityEdge(QUmlActivityEdge *realizingActivityEdge) { // This is a read-write association end @@ -259,6 +325,11 @@ void QUmlInformationFlow::addRealizingActivityEdge(QUmlActivityEdge *realizingAc } } +/*! + Removes \a realizingActivityEdge from realizingActivityEdges. + + \sa realizingActivityEdges(), addRealizingActivityEdge() + */ void QUmlInformationFlow::removeRealizingActivityEdge(QUmlActivityEdge *realizingActivityEdge) { // This is a read-write association end @@ -270,6 +341,8 @@ void QUmlInformationFlow::removeRealizingActivityEdge(QUmlActivityEdge *realizin /*! Determines which Connectors will realize the specified flow. + + \sa addRealizingConnector(), removeRealizingConnector() */ const QSet<QUmlConnector *> QUmlInformationFlow::realizingConnectors() const { @@ -278,6 +351,11 @@ const QSet<QUmlConnector *> QUmlInformationFlow::realizingConnectors() const return _realizingConnectors; } +/*! + Adds \a realizingConnector to realizingConnectors. + + \sa realizingConnectors(), removeRealizingConnector() + */ void QUmlInformationFlow::addRealizingConnector(QUmlConnector *realizingConnector) { // This is a read-write association end @@ -289,6 +367,11 @@ void QUmlInformationFlow::addRealizingConnector(QUmlConnector *realizingConnecto } } +/*! + Removes \a realizingConnector from realizingConnectors. + + \sa realizingConnectors(), addRealizingConnector() + */ void QUmlInformationFlow::removeRealizingConnector(QUmlConnector *realizingConnector) { // This is a read-write association end @@ -300,6 +383,8 @@ void QUmlInformationFlow::removeRealizingConnector(QUmlConnector *realizingConne /*! Determines which Messages will realize the specified flow. + + \sa addRealizingMessage(), removeRealizingMessage() */ const QSet<QUmlMessage *> QUmlInformationFlow::realizingMessages() const { @@ -308,6 +393,11 @@ const QSet<QUmlMessage *> QUmlInformationFlow::realizingMessages() const return _realizingMessages; } +/*! + Adds \a realizingMessage to realizingMessages. + + \sa realizingMessages(), removeRealizingMessage() + */ void QUmlInformationFlow::addRealizingMessage(QUmlMessage *realizingMessage) { // This is a read-write association end @@ -319,6 +409,11 @@ void QUmlInformationFlow::addRealizingMessage(QUmlMessage *realizingMessage) } } +/*! + Removes \a realizingMessage from realizingMessages. + + \sa realizingMessages(), addRealizingMessage() + */ void QUmlInformationFlow::removeRealizingMessage(QUmlMessage *realizingMessage) { // This is a read-write association end diff --git a/src/uml/qumlinformationflow.h b/src/uml/qumlinformationflow.h index 59550689..2b3b525f 100644 --- a/src/uml/qumlinformationflow.h +++ b/src/uml/qumlinformationflow.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlDirectedRelationship> #include <QtUml/QUmlPackageableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -103,7 +101,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInformationFlow) *) -QT_END_HEADER - #endif // QUMLINFORMATIONFLOW_H diff --git a/src/uml/qumlinformationitem.cpp b/src/uml/qumlinformationitem.cpp index b3cb35f2..9656931b 100644 --- a/src/uml/qumlinformationitem.cpp +++ b/src/uml/qumlinformationitem.cpp @@ -78,12 +78,19 @@ QT_BEGIN_NAMESPACE \brief An information item is an abstraction of all kinds of information that can be exchanged between objects. It is a kind of classifier intended for representing information in a very abstract way, one which cannot be instantiated. */ + +/*! + Creates a new QUmlInformationItem. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInformationItem::QUmlInformationItem(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInformationItemObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInformationItem. +*/ QModelingElement *QUmlInformationItem::clone() const { QUmlInformationItem *c = new QUmlInformationItem; @@ -139,6 +146,8 @@ QModelingElement *QUmlInformationItem::clone() const /*! Determines the classifiers that will specify the structure and nature of the information. An information item represents all its represented classifiers. + + \sa addRepresented(), removeRepresented() */ const QSet<QUmlClassifier *> QUmlInformationItem::represented() const { @@ -147,6 +156,11 @@ const QSet<QUmlClassifier *> QUmlInformationItem::represented() const return _represented; } +/*! + Adds \a represented to represented. + + \sa represented(), removeRepresented() + */ void QUmlInformationItem::addRepresented(QUmlClassifier *represented) { // This is a read-write association end @@ -158,6 +172,11 @@ void QUmlInformationItem::addRepresented(QUmlClassifier *represented) } } +/*! + Removes \a represented from represented. + + \sa represented(), addRepresented() + */ void QUmlInformationItem::removeRepresented(QUmlClassifier *represented) { // This is a read-write association end diff --git a/src/uml/qumlinformationitem.h b/src/uml/qumlinformationitem.h index 15415567..36263116 100644 --- a/src/uml/qumlinformationitem.h +++ b/src/uml/qumlinformationitem.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -71,7 +69,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInformationItem) *) -QT_END_HEADER - #endif // QUMLINFORMATIONITEM_H diff --git a/src/uml/qumlinitialnode.cpp b/src/uml/qumlinitialnode.cpp index 11388890..7c8f2aa7 100644 --- a/src/uml/qumlinitialnode.cpp +++ b/src/uml/qumlinitialnode.cpp @@ -68,12 +68,19 @@ QT_BEGIN_NAMESPACE \brief An initial node is a control node at which flow starts when the activity is invoked. */ + +/*! + Creates a new QUmlInitialNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInitialNode::QUmlInitialNode(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInitialNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInitialNode. +*/ QModelingElement *QUmlInitialNode::clone() const { QUmlInitialNode *c = new QUmlInitialNode; diff --git a/src/uml/qumlinitialnode.h b/src/uml/qumlinitialnode.h index 600a4fee..f1a570cf 100644 --- a/src/uml/qumlinitialnode.h +++ b/src/uml/qumlinitialnode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlControlNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInitialNode) *) -QT_END_HEADER - #endif // QUMLINITIALNODE_H diff --git a/src/uml/qumlinputpin.cpp b/src/uml/qumlinputpin.cpp index 6fbb4046..0831d045 100644 --- a/src/uml/qumlinputpin.cpp +++ b/src/uml/qumlinputpin.cpp @@ -73,12 +73,19 @@ QT_BEGIN_NAMESPACE \brief An input pin is a pin that holds input values to be consumed by an action. */ + +/*! + Creates a new QUmlInputPin. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInputPin::QUmlInputPin(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInputPinObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInputPin. +*/ QModelingElement *QUmlInputPin::clone() const { QUmlInputPin *c = new QUmlInputPin; diff --git a/src/uml/qumlinputpin.h b/src/uml/qumlinputpin.h index b11f1b05..7c00b50b 100644 --- a/src/uml/qumlinputpin.h +++ b/src/uml/qumlinputpin.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlPin> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInputPin) *) -QT_END_HEADER - #endif // QUMLINPUTPIN_H diff --git a/src/uml/qumlinstancespecification.cpp b/src/uml/qumlinstancespecification.cpp index 8dbfdbf0..f3c057c0 100644 --- a/src/uml/qumlinstancespecification.cpp +++ b/src/uml/qumlinstancespecification.cpp @@ -65,6 +65,10 @@ QT_BEGIN_NAMESPACE \brief An instance specification has the capability of being a deployment target in a deployment relationship, in the case that it is an instance of a node. It is also has the capability of being a deployed artifact, if it is an instance of an artifact.An instance specification is a model element that represents an instance in a modeled system. */ + +/*! + Creates a new QUmlInstanceSpecification. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInstanceSpecification::QUmlInstanceSpecification(bool createQModelingObject) : _specification(0) { @@ -72,6 +76,9 @@ QUmlInstanceSpecification::QUmlInstanceSpecification(bool createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInstanceSpecificationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInstanceSpecification. +*/ QModelingElement *QUmlInstanceSpecification::clone() const { QUmlInstanceSpecification *c = new QUmlInstanceSpecification; @@ -102,6 +109,8 @@ QModelingElement *QUmlInstanceSpecification::clone() const /*! The classifier or classifiers of the represented instance. If multiple classifiers are specified, the instance is classified by all of them. + + \sa addClassifier(), removeClassifier() */ const QSet<QUmlClassifier *> QUmlInstanceSpecification::classifiers() const { @@ -110,6 +119,11 @@ const QSet<QUmlClassifier *> QUmlInstanceSpecification::classifiers() const return _classifiers; } +/*! + Adds \a classifier to classifiers. + + \sa classifiers(), removeClassifier() + */ void QUmlInstanceSpecification::addClassifier(QUmlClassifier *classifier) { // This is a read-write association end @@ -121,6 +135,11 @@ void QUmlInstanceSpecification::addClassifier(QUmlClassifier *classifier) } } +/*! + Removes \a classifier from classifiers. + + \sa classifiers(), addClassifier() + */ void QUmlInstanceSpecification::removeClassifier(QUmlClassifier *classifier) { // This is a read-write association end @@ -132,6 +151,12 @@ void QUmlInstanceSpecification::removeClassifier(QUmlClassifier *classifier) /*! A slot giving the value or values of a structural feature of the instance. An instance specification can have one slot per structural feature of its classifiers, including inherited features. It is not necessary to model a slot for each structural feature, in which case the instance specification is a partial description. + + \sa addSlot(), removeSlot() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlSlot::owningInstance(). */ const QSet<QUmlSlot *> QUmlInstanceSpecification::slots_() const { @@ -140,6 +165,11 @@ const QSet<QUmlSlot *> QUmlInstanceSpecification::slots_() const return _slots_; } +/*! + Adds \a slot_ to slots_. + + \sa slots_(), removeSlot() + */ void QUmlInstanceSpecification::addSlot(QUmlSlot *slot_) { // This is a read-write association end @@ -160,6 +190,11 @@ void QUmlInstanceSpecification::addSlot(QUmlSlot *slot_) } } +/*! + Removes \a slot_ from slots_. + + \sa slots_(), addSlot() + */ void QUmlInstanceSpecification::removeSlot(QUmlSlot *slot_) { // This is a read-write association end @@ -181,6 +216,8 @@ void QUmlInstanceSpecification::removeSlot(QUmlSlot *slot_) /*! A specification of how to compute, derive, or construct the instance. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlInstanceSpecification::specification() const { @@ -189,6 +226,9 @@ QUmlValueSpecification *QUmlInstanceSpecification::specification() const return _specification; } +/*! + Adjusts specification to \a specification. + */ void QUmlInstanceSpecification::setSpecification(QUmlValueSpecification *specification) { // This is a read-write association end diff --git a/src/uml/qumlinstancespecification.h b/src/uml/qumlinstancespecification.h index 5491c868..8d1222ea 100644 --- a/src/uml/qumlinstancespecification.h +++ b/src/uml/qumlinstancespecification.h @@ -47,8 +47,6 @@ #include <QtUml/QUmlPackageableElement> #include <QtUml/QUmlDeploymentTarget> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -84,7 +82,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInstanceSpecification) *) -QT_END_HEADER - #endif // QUMLINSTANCESPECIFICATION_H diff --git a/src/uml/qumlinstancevalue.cpp b/src/uml/qumlinstancevalue.cpp index 17c69661..cae419ff 100644 --- a/src/uml/qumlinstancevalue.cpp +++ b/src/uml/qumlinstancevalue.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief An instance value is a value specification that identifies an instance. */ + +/*! + Creates a new QUmlInstanceValue. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInstanceValue::QUmlInstanceValue(bool createQModelingObject) : _instance(0) { @@ -70,6 +74,9 @@ QUmlInstanceValue::QUmlInstanceValue(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInstanceValueObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInstanceValue. +*/ QModelingElement *QUmlInstanceValue::clone() const { QUmlInstanceValue *c = new QUmlInstanceValue; @@ -104,6 +111,9 @@ QUmlInstanceSpecification *QUmlInstanceValue::instance() const return _instance; } +/*! + Adjusts instance to \a instance. + */ void QUmlInstanceValue::setInstance(QUmlInstanceSpecification *instance) { // This is a read-write association end diff --git a/src/uml/qumlinstancevalue.h b/src/uml/qumlinstancevalue.h index 56eb34bb..14ad6b4e 100644 --- a/src/uml/qumlinstancevalue.h +++ b/src/uml/qumlinstancevalue.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlValueSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInstanceValue) *) -QT_END_HEADER - #endif // QUMLINSTANCEVALUE_H diff --git a/src/uml/qumlinteraction.cpp b/src/uml/qumlinteraction.cpp index 07d12bf4..be385b76 100644 --- a/src/uml/qumlinteraction.cpp +++ b/src/uml/qumlinteraction.cpp @@ -97,12 +97,19 @@ QT_BEGIN_NAMESPACE \brief An interaction is a unit of behavior that focuses on the observable exchange of information between connectable elements. */ + +/*! + Creates a new QUmlInteraction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInteraction::QUmlInteraction(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInteractionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInteraction. +*/ QModelingElement *QUmlInteraction::clone() const { QUmlInteraction *c = new QUmlInteraction; @@ -204,6 +211,10 @@ QModelingElement *QUmlInteraction::clone() const /*! Actions owned by the Interaction. + + \sa addAction(), removeAction() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlAction *> QUmlInteraction::actions() const { @@ -212,6 +223,11 @@ const QSet<QUmlAction *> QUmlInteraction::actions() const return _actions; } +/*! + Adds \a action to actions. + + \sa actions(), removeAction() + */ void QUmlInteraction::addAction(QUmlAction *action) { // This is a read-write association end @@ -227,6 +243,11 @@ void QUmlInteraction::addAction(QUmlAction *action) } } +/*! + Removes \a action from actions. + + \sa actions(), addAction() + */ void QUmlInteraction::removeAction(QUmlAction *action) { // This is a read-write association end @@ -243,6 +264,10 @@ void QUmlInteraction::removeAction(QUmlAction *action) /*! Specifies the gates that form the message interface between this Interaction and any InteractionUses which reference it. + + \sa addFormalGate(), removeFormalGate() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QSet<QUmlGate *> QUmlInteraction::formalGates() const { @@ -251,6 +276,11 @@ const QSet<QUmlGate *> QUmlInteraction::formalGates() const return _formalGates; } +/*! + Adds \a formalGate to formalGates. + + \sa formalGates(), removeFormalGate() + */ void QUmlInteraction::addFormalGate(QUmlGate *formalGate) { // This is a read-write association end @@ -266,6 +296,11 @@ void QUmlInteraction::addFormalGate(QUmlGate *formalGate) } } +/*! + Removes \a formalGate from formalGates. + + \sa formalGates(), addFormalGate() + */ void QUmlInteraction::removeFormalGate(QUmlGate *formalGate) { // This is a read-write association end @@ -282,6 +317,12 @@ void QUmlInteraction::removeFormalGate(QUmlGate *formalGate) /*! The ordered set of fragments in the Interaction. + + \sa addFragment(), removeFragment() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlInteractionFragment::enclosingInteraction(). */ const QList<QUmlInteractionFragment *> QUmlInteraction::fragments() const { @@ -290,6 +331,11 @@ const QList<QUmlInteractionFragment *> QUmlInteraction::fragments() const return _fragments; } +/*! + Adds \a fragment to fragments. + + \sa fragments(), removeFragment() + */ void QUmlInteraction::addFragment(QUmlInteractionFragment *fragment) { // This is a read-write association end @@ -310,6 +356,11 @@ void QUmlInteraction::addFragment(QUmlInteractionFragment *fragment) } } +/*! + Removes \a fragment from fragments. + + \sa fragments(), addFragment() + */ void QUmlInteraction::removeFragment(QUmlInteractionFragment *fragment) { // This is a read-write association end @@ -331,6 +382,12 @@ void QUmlInteraction::removeFragment(QUmlInteractionFragment *fragment) /*! Specifies the participants in this Interaction. + + \sa addLifeline(), removeLifeline() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlLifeline::interaction(). */ const QSet<QUmlLifeline *> QUmlInteraction::lifelines() const { @@ -339,6 +396,11 @@ const QSet<QUmlLifeline *> QUmlInteraction::lifelines() const return _lifelines; } +/*! + Adds \a lifeline to lifelines. + + \sa lifelines(), removeLifeline() + */ void QUmlInteraction::addLifeline(QUmlLifeline *lifeline) { // This is a read-write association end @@ -359,6 +421,11 @@ void QUmlInteraction::addLifeline(QUmlLifeline *lifeline) } } +/*! + Removes \a lifeline from lifelines. + + \sa lifelines(), addLifeline() + */ void QUmlInteraction::removeLifeline(QUmlLifeline *lifeline) { // This is a read-write association end @@ -380,6 +447,12 @@ void QUmlInteraction::removeLifeline(QUmlLifeline *lifeline) /*! The Messages contained in this Interaction. + + \sa addMessage(), removeMessage() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlMessage::interaction(). */ const QSet<QUmlMessage *> QUmlInteraction::messages() const { @@ -388,6 +461,11 @@ const QSet<QUmlMessage *> QUmlInteraction::messages() const return _messages; } +/*! + Adds \a message to messages. + + \sa messages(), removeMessage() + */ void QUmlInteraction::addMessage(QUmlMessage *message) { // This is a read-write association end @@ -408,6 +486,11 @@ void QUmlInteraction::addMessage(QUmlMessage *message) } } +/*! + Removes \a message from messages. + + \sa messages(), addMessage() + */ void QUmlInteraction::removeMessage(QUmlMessage *message) { // This is a read-write association end diff --git a/src/uml/qumlinteraction.h b/src/uml/qumlinteraction.h index 9c2062a9..098eb4ef 100644 --- a/src/uml/qumlinteraction.h +++ b/src/uml/qumlinteraction.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlBehavior> #include <QtUml/QUmlInteractionFragment> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -93,7 +91,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInteraction) *) -QT_END_HEADER - #endif // QUMLINTERACTION_H diff --git a/src/uml/qumlinteractionconstraint.cpp b/src/uml/qumlinteractionconstraint.cpp index b487dd7f..cfeca233 100644 --- a/src/uml/qumlinteractionconstraint.cpp +++ b/src/uml/qumlinteractionconstraint.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief An interaction constraint is a Boolean expression that guards an operand in a combined fragment. */ + +/*! + Creates a new QUmlInteractionConstraint. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInteractionConstraint::QUmlInteractionConstraint(bool createQModelingObject) : QUmlConstraint(false), _maxint(0), @@ -71,6 +75,9 @@ QUmlInteractionConstraint::QUmlInteractionConstraint(bool createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInteractionConstraintObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInteractionConstraint. +*/ QModelingElement *QUmlInteractionConstraint::clone() const { QUmlInteractionConstraint *c = new QUmlInteractionConstraint; @@ -103,6 +110,8 @@ QModelingElement *QUmlInteractionConstraint::clone() const /*! The maximum number of iterations of a loop + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlInteractionConstraint::maxint() const { @@ -111,6 +120,9 @@ QUmlValueSpecification *QUmlInteractionConstraint::maxint() const return _maxint; } +/*! + Adjusts maxint to \a maxint. + */ void QUmlInteractionConstraint::setMaxint(QUmlValueSpecification *maxint) { // This is a read-write association end @@ -133,6 +145,8 @@ void QUmlInteractionConstraint::setMaxint(QUmlValueSpecification *maxint) /*! The minimum number of iterations of a loop + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlInteractionConstraint::minint() const { @@ -141,6 +155,9 @@ QUmlValueSpecification *QUmlInteractionConstraint::minint() const return _minint; } +/*! + Adjusts minint to \a minint. + */ void QUmlInteractionConstraint::setMinint(QUmlValueSpecification *minint) { // This is a read-write association end diff --git a/src/uml/qumlinteractionconstraint.h b/src/uml/qumlinteractionconstraint.h index 07cd5158..9130911a 100644 --- a/src/uml/qumlinteractionconstraint.h +++ b/src/uml/qumlinteractionconstraint.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlConstraint> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInteractionConstraint) *) -QT_END_HEADER - #endif // QUMLINTERACTIONCONSTRAINT_H diff --git a/src/uml/qumlinteractionfragment.cpp b/src/uml/qumlinteractionfragment.cpp index 9eae4d3c..196fde7a 100644 --- a/src/uml/qumlinteractionfragment.cpp +++ b/src/uml/qumlinteractionfragment.cpp @@ -59,13 +59,22 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief InteractionFragment is an abstract notion of the most general interaction unit. An interaction fragment is a piece of an interaction. Each interaction fragment is conceptually like an interaction by itself. + + \b {QUmlInteractionFragment is an abstract class.} */ + +/*! + Creates a new QUmlInteractionFragment. +*/ QUmlInteractionFragment::QUmlInteractionFragment() : _enclosingInteraction(0), _enclosingOperand(0) { } +/*! + Returns a deep-copied clone of the QUmlInteractionFragment. +*/ QModelingElement *QUmlInteractionFragment::clone() const { QUmlInteractionFragment *c = new QUmlInteractionFragment; @@ -92,6 +101,10 @@ QModelingElement *QUmlInteractionFragment::clone() const /*! References the Lifelines that the InteractionFragment involves. + + \sa addCovered(), removeCovered() + + \b {Opposite property(ies):} QUmlLifeline::coveredBy(). */ const QSet<QUmlLifeline *> QUmlInteractionFragment::covered() const { @@ -100,6 +113,11 @@ const QSet<QUmlLifeline *> QUmlInteractionFragment::covered() const return _covered; } +/*! + Adds \a covered to covered. + + \sa covered(), removeCovered() + */ void QUmlInteractionFragment::addCovered(QUmlLifeline *covered) { // This is a read-write association end @@ -116,6 +134,11 @@ void QUmlInteractionFragment::addCovered(QUmlLifeline *covered) } } +/*! + Removes \a covered from covered. + + \sa covered(), addCovered() + */ void QUmlInteractionFragment::removeCovered(QUmlLifeline *covered) { // This is a read-write association end @@ -132,6 +155,10 @@ void QUmlInteractionFragment::removeCovered(QUmlLifeline *covered) /*! The Interaction enclosing this InteractionFragment. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlInteraction::fragments(). */ QUmlInteraction *QUmlInteractionFragment::enclosingInteraction() const { @@ -140,6 +167,9 @@ QUmlInteraction *QUmlInteractionFragment::enclosingInteraction() const return _enclosingInteraction; } +/*! + Adjusts enclosingInteraction to \a enclosingInteraction. + */ void QUmlInteractionFragment::setEnclosingInteraction(QUmlInteraction *enclosingInteraction) { // This is a read-write association end @@ -158,6 +188,10 @@ void QUmlInteractionFragment::setEnclosingInteraction(QUmlInteraction *enclosing /*! The operand enclosing this InteractionFragment (they may nest recursively) + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlInteractionOperand::fragments(). */ QUmlInteractionOperand *QUmlInteractionFragment::enclosingOperand() const { @@ -166,6 +200,9 @@ QUmlInteractionOperand *QUmlInteractionFragment::enclosingOperand() const return _enclosingOperand; } +/*! + Adjusts enclosingOperand to \a enclosingOperand. + */ void QUmlInteractionFragment::setEnclosingOperand(QUmlInteractionOperand *enclosingOperand) { // This is a read-write association end @@ -184,6 +221,10 @@ void QUmlInteractionFragment::setEnclosingOperand(QUmlInteractionOperand *enclos /*! The general ordering relationships contained in this fragment. + + \sa addGeneralOrdering(), removeGeneralOrdering() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlGeneralOrdering *> QUmlInteractionFragment::generalOrderings() const { @@ -192,6 +233,11 @@ const QSet<QUmlGeneralOrdering *> QUmlInteractionFragment::generalOrderings() co return _generalOrderings; } +/*! + Adds \a generalOrdering to generalOrderings. + + \sa generalOrderings(), removeGeneralOrdering() + */ void QUmlInteractionFragment::addGeneralOrdering(QUmlGeneralOrdering *generalOrdering) { // This is a read-write association end @@ -207,6 +253,11 @@ void QUmlInteractionFragment::addGeneralOrdering(QUmlGeneralOrdering *generalOrd } } +/*! + Removes \a generalOrdering from generalOrderings. + + \sa generalOrderings(), addGeneralOrdering() + */ void QUmlInteractionFragment::removeGeneralOrdering(QUmlGeneralOrdering *generalOrdering) { // This is a read-write association end diff --git a/src/uml/qumlinteractionfragment.h b/src/uml/qumlinteractionfragment.h index 42692422..a5e884ed 100644 --- a/src/uml/qumlinteractionfragment.h +++ b/src/uml/qumlinteractionfragment.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -86,7 +84,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInteractionFragment) *) -QT_END_HEADER - #endif // QUMLINTERACTIONFRAGMENT_H diff --git a/src/uml/qumlinteractionoperand.cpp b/src/uml/qumlinteractionoperand.cpp index e15f5ed8..548d16c1 100644 --- a/src/uml/qumlinteractionoperand.cpp +++ b/src/uml/qumlinteractionoperand.cpp @@ -66,6 +66,10 @@ QT_BEGIN_NAMESPACE \brief An interaction operand is contained in a combined fragment. An interaction operand represents one operand of the expression given by the enclosing combined fragment. */ + +/*! + Creates a new QUmlInteractionOperand. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInteractionOperand::QUmlInteractionOperand(bool createQModelingObject) : _guard(0) { @@ -73,6 +77,9 @@ QUmlInteractionOperand::QUmlInteractionOperand(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInteractionOperandObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInteractionOperand. +*/ QModelingElement *QUmlInteractionOperand::clone() const { QUmlInteractionOperand *c = new QUmlInteractionOperand; @@ -109,6 +116,12 @@ QModelingElement *QUmlInteractionOperand::clone() const /*! The fragments of the operand. + + \sa addFragment(), removeFragment() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlInteractionFragment::enclosingOperand(). */ const QList<QUmlInteractionFragment *> QUmlInteractionOperand::fragments() const { @@ -117,6 +130,11 @@ const QList<QUmlInteractionFragment *> QUmlInteractionOperand::fragments() const return _fragments; } +/*! + Adds \a fragment to fragments. + + \sa fragments(), removeFragment() + */ void QUmlInteractionOperand::addFragment(QUmlInteractionFragment *fragment) { // This is a read-write association end @@ -137,6 +155,11 @@ void QUmlInteractionOperand::addFragment(QUmlInteractionFragment *fragment) } } +/*! + Removes \a fragment from fragments. + + \sa fragments(), addFragment() + */ void QUmlInteractionOperand::removeFragment(QUmlInteractionFragment *fragment) { // This is a read-write association end @@ -158,6 +181,8 @@ void QUmlInteractionOperand::removeFragment(QUmlInteractionFragment *fragment) /*! Constraint of the operand. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlInteractionConstraint *QUmlInteractionOperand::guard() const { @@ -166,6 +191,9 @@ QUmlInteractionConstraint *QUmlInteractionOperand::guard() const return _guard; } +/*! + Adjusts guard to \a guard. + */ void QUmlInteractionOperand::setGuard(QUmlInteractionConstraint *guard) { // This is a read-write association end diff --git a/src/uml/qumlinteractionoperand.h b/src/uml/qumlinteractionoperand.h index c4d9d143..f092a7e1 100644 --- a/src/uml/qumlinteractionoperand.h +++ b/src/uml/qumlinteractionoperand.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlInteractionFragment> #include <QtUml/QUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -77,7 +75,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInteractionOperand) *) -QT_END_HEADER - #endif // QUMLINTERACTIONOPERAND_H diff --git a/src/uml/qumlinteractionuse.cpp b/src/uml/qumlinteractionuse.cpp index 43d711b6..ea64decb 100644 --- a/src/uml/qumlinteractionuse.cpp +++ b/src/uml/qumlinteractionuse.cpp @@ -66,6 +66,10 @@ QT_BEGIN_NAMESPACE \brief An interaction use refers to an interaction. The interaction use is a shorthand for copying the contents of the referenced interaction where the interaction use is. To be accurate the copying must take into account substituting parameters with arguments and connect the formal gates with the actual ones. */ + +/*! + Creates a new QUmlInteractionUse. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInteractionUse::QUmlInteractionUse(bool createQModelingObject) : _refersTo(0), _returnValue(0), @@ -75,6 +79,9 @@ QUmlInteractionUse::QUmlInteractionUse(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInteractionUseObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInteractionUse. +*/ QModelingElement *QUmlInteractionUse::clone() const { QUmlInteractionUse *c = new QUmlInteractionUse; @@ -111,6 +118,10 @@ QModelingElement *QUmlInteractionUse::clone() const /*! The actual gates of the InteractionUse + + \sa addActualGate(), removeActualGate() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlGate *> QUmlInteractionUse::actualGates() const { @@ -119,6 +130,11 @@ const QSet<QUmlGate *> QUmlInteractionUse::actualGates() const return _actualGates; } +/*! + Adds \a actualGate to actualGates. + + \sa actualGates(), removeActualGate() + */ void QUmlInteractionUse::addActualGate(QUmlGate *actualGate) { // This is a read-write association end @@ -134,6 +150,11 @@ void QUmlInteractionUse::addActualGate(QUmlGate *actualGate) } } +/*! + Removes \a actualGate from actualGates. + + \sa actualGates(), addActualGate() + */ void QUmlInteractionUse::removeActualGate(QUmlGate *actualGate) { // This is a read-write association end @@ -150,6 +171,10 @@ void QUmlInteractionUse::removeActualGate(QUmlGate *actualGate) /*! The actual arguments of the Interaction + + \sa addArgument(), removeArgument() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QList<QUmlValueSpecification *> QUmlInteractionUse::arguments() const { @@ -158,6 +183,11 @@ const QList<QUmlValueSpecification *> QUmlInteractionUse::arguments() const return _arguments; } +/*! + Adds \a argument to arguments. + + \sa arguments(), removeArgument() + */ void QUmlInteractionUse::addArgument(QUmlValueSpecification *argument) { // This is a read-write association end @@ -173,6 +203,11 @@ void QUmlInteractionUse::addArgument(QUmlValueSpecification *argument) } } +/*! + Removes \a argument from arguments. + + \sa arguments(), addArgument() + */ void QUmlInteractionUse::removeArgument(QUmlValueSpecification *argument) { // This is a read-write association end @@ -197,6 +232,9 @@ QUmlInteraction *QUmlInteractionUse::refersTo() const return _refersTo; } +/*! + Adjusts refersTo to \a refersTo. + */ void QUmlInteractionUse::setRefersTo(QUmlInteraction *refersTo) { // This is a read-write association end @@ -210,6 +248,8 @@ void QUmlInteractionUse::setRefersTo(QUmlInteraction *refersTo) /*! The value of the executed Interaction. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlInteractionUse::returnValue() const { @@ -218,6 +258,9 @@ QUmlValueSpecification *QUmlInteractionUse::returnValue() const return _returnValue; } +/*! + Adjusts returnValue to \a returnValue. + */ void QUmlInteractionUse::setReturnValue(QUmlValueSpecification *returnValue) { // This is a read-write association end @@ -248,6 +291,9 @@ QUmlProperty *QUmlInteractionUse::returnValueRecipient() const return _returnValueRecipient; } +/*! + Adjusts returnValueRecipient to \a returnValueRecipient. + */ void QUmlInteractionUse::setReturnValueRecipient(QUmlProperty *returnValueRecipient) { // This is a read-write association end diff --git a/src/uml/qumlinteractionuse.h b/src/uml/qumlinteractionuse.h index 2cba9a08..257456d2 100644 --- a/src/uml/qumlinteractionuse.h +++ b/src/uml/qumlinteractionuse.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInteractionFragment> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -89,7 +87,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInteractionUse) *) -QT_END_HEADER - #endif // QUMLINTERACTIONUSE_H diff --git a/src/uml/qumlinterface.cpp b/src/uml/qumlinterface.cpp index 9aee56d0..00b13ca1 100644 --- a/src/uml/qumlinterface.cpp +++ b/src/uml/qumlinterface.cpp @@ -81,6 +81,10 @@ QT_BEGIN_NAMESPACE \brief Since an interface specifies conformance characteristics, it does not own detailed behavior specifications. Instead, interfaces may own a protocol state machine that specifies event sequences and pre/post conditions for the operations and receptions described by the interface.Interfaces may include receptions (in addition to operations).An interface is a kind of classifier that represents a declaration of a set of coherent public features and obligations. An interface specifies a contract; any instance of a classifier that realizes the interface must fulfill that contract. The obligations that may be associated with an interface are in the form of various kinds of constraints (such as pre- and post-conditions) or protocol specifications, which may impose ordering restrictions on interactions through the interface. */ + +/*! + Creates a new QUmlInterface. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInterface::QUmlInterface(bool createQModelingObject) : _protocol(0) { @@ -88,6 +92,9 @@ QUmlInterface::QUmlInterface(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInterfaceObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInterface. +*/ QModelingElement *QUmlInterface::clone() const { QUmlInterface *c = new QUmlInterface; @@ -153,6 +160,10 @@ QModelingElement *QUmlInterface::clone() const /*! References all the Classifiers that are defined (nested) within the Class. + + \sa addNestedClassifier(), removeNestedClassifier() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QList<QUmlClassifier *> QUmlInterface::nestedClassifiers() const { @@ -161,6 +172,11 @@ const QList<QUmlClassifier *> QUmlInterface::nestedClassifiers() const return _nestedClassifiers; } +/*! + Adds \a nestedClassifier to nestedClassifiers. + + \sa nestedClassifiers(), removeNestedClassifier() + */ void QUmlInterface::addNestedClassifier(QUmlClassifier *nestedClassifier) { // This is a read-write association end @@ -176,6 +192,11 @@ void QUmlInterface::addNestedClassifier(QUmlClassifier *nestedClassifier) } } +/*! + Removes \a nestedClassifier from nestedClassifiers. + + \sa nestedClassifiers(), addNestedClassifier() + */ void QUmlInterface::removeNestedClassifier(QUmlClassifier *nestedClassifier) { // This is a read-write association end @@ -192,6 +213,12 @@ void QUmlInterface::removeNestedClassifier(QUmlClassifier *nestedClassifier) /*! The attributes (i.e. the properties) owned by the class. + + \sa addOwnedAttribute(), removeOwnedAttribute() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(), QUmlClassifier::attributes(). + + \b {Opposite property(ies):} QUmlProperty::interface_(). */ const QList<QUmlProperty *> QUmlInterface::ownedAttributes() const { @@ -200,6 +227,11 @@ const QList<QUmlProperty *> QUmlInterface::ownedAttributes() const return _ownedAttributes; } +/*! + Adds \a ownedAttribute to ownedAttributes. + + \sa ownedAttributes(), removeOwnedAttribute() + */ void QUmlInterface::addOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end @@ -221,6 +253,11 @@ void QUmlInterface::addOwnedAttribute(QUmlProperty *ownedAttribute) } } +/*! + Removes \a ownedAttribute from ownedAttributes. + + \sa ownedAttributes(), addOwnedAttribute() + */ void QUmlInterface::removeOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end @@ -243,6 +280,12 @@ void QUmlInterface::removeOwnedAttribute(QUmlProperty *ownedAttribute) /*! The operations owned by the class. + + \sa addOwnedOperation(), removeOwnedOperation() + + \b {Subsetted property(ies):} QUmlClassifier::features(), QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlOperation::interface_(). */ const QList<QUmlOperation *> QUmlInterface::ownedOperations() const { @@ -251,6 +294,11 @@ const QList<QUmlOperation *> QUmlInterface::ownedOperations() const return _ownedOperations; } +/*! + Adds \a ownedOperation to ownedOperations. + + \sa ownedOperations(), removeOwnedOperation() + */ void QUmlInterface::addOwnedOperation(QUmlOperation *ownedOperation) { // This is a read-write association end @@ -272,6 +320,11 @@ void QUmlInterface::addOwnedOperation(QUmlOperation *ownedOperation) } } +/*! + Removes \a ownedOperation from ownedOperations. + + \sa ownedOperations(), addOwnedOperation() + */ void QUmlInterface::removeOwnedOperation(QUmlOperation *ownedOperation) { // This is a read-write association end @@ -294,6 +347,10 @@ void QUmlInterface::removeOwnedOperation(QUmlOperation *ownedOperation) /*! Receptions that objects providing this interface are willing to accept. + + \sa addOwnedReception(), removeOwnedReception() + + \b {Subsetted property(ies):} QUmlClassifier::features(), QUmlNamespace::ownedMembers(). */ const QSet<QUmlReception *> QUmlInterface::ownedReceptions() const { @@ -302,6 +359,11 @@ const QSet<QUmlReception *> QUmlInterface::ownedReceptions() const return _ownedReceptions; } +/*! + Adds \a ownedReception to ownedReceptions. + + \sa ownedReceptions(), removeOwnedReception() + */ void QUmlInterface::addOwnedReception(QUmlReception *ownedReception) { // This is a read-write association end @@ -318,6 +380,11 @@ void QUmlInterface::addOwnedReception(QUmlReception *ownedReception) } } +/*! + Removes \a ownedReception from ownedReceptions. + + \sa ownedReceptions(), addOwnedReception() + */ void QUmlInterface::removeOwnedReception(QUmlReception *ownedReception) { // This is a read-write association end @@ -335,6 +402,8 @@ void QUmlInterface::removeOwnedReception(QUmlReception *ownedReception) /*! References a protocol state machine specifying the legal sequences of the invocation of the behavioral features described in the interface. + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ QUmlProtocolStateMachine *QUmlInterface::protocol() const { @@ -343,6 +412,9 @@ QUmlProtocolStateMachine *QUmlInterface::protocol() const return _protocol; } +/*! + Adjusts protocol to \a protocol. + */ void QUmlInterface::setProtocol(QUmlProtocolStateMachine *protocol) { // This is a read-write association end @@ -365,6 +437,10 @@ void QUmlInterface::setProtocol(QUmlProtocolStateMachine *protocol) /*! References all the Interfaces redefined by this Interface. + + \sa addRedefinedInterface(), removeRedefinedInterface() + + \b {Subsetted property(ies):} QUmlClassifier::redefinedClassifiers(). */ const QSet<QUmlInterface *> QUmlInterface::redefinedInterfaces() const { @@ -373,6 +449,11 @@ const QSet<QUmlInterface *> QUmlInterface::redefinedInterfaces() const return _redefinedInterfaces; } +/*! + Adds \a redefinedInterface to redefinedInterfaces. + + \sa redefinedInterfaces(), removeRedefinedInterface() + */ void QUmlInterface::addRedefinedInterface(QUmlInterface *redefinedInterface) { // This is a read-write association end @@ -387,6 +468,11 @@ void QUmlInterface::addRedefinedInterface(QUmlInterface *redefinedInterface) } } +/*! + Removes \a redefinedInterface from redefinedInterfaces. + + \sa redefinedInterfaces(), addRedefinedInterface() + */ void QUmlInterface::removeRedefinedInterface(QUmlInterface *redefinedInterface) { // This is a read-write association end diff --git a/src/uml/qumlinterface.h b/src/uml/qumlinterface.h index 36b03f41..f9f56042 100644 --- a/src/uml/qumlinterface.h +++ b/src/uml/qumlinterface.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -95,7 +93,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInterface) *) -QT_END_HEADER - #endif // QUMLINTERFACE_H diff --git a/src/uml/qumlinterfacerealization.cpp b/src/uml/qumlinterfacerealization.cpp index 4901c454..54a5dfd3 100644 --- a/src/uml/qumlinterfacerealization.cpp +++ b/src/uml/qumlinterfacerealization.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief An interface realization is a specialized realization relationship between a classifier and an interface. This relationship signifies that the realizing classifier conforms to the contract specified by the interface. */ + +/*! + Creates a new QUmlInterfaceRealization. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInterfaceRealization::QUmlInterfaceRealization(bool createQModelingObject) : QUmlRealization(false), _contract(0), @@ -73,6 +77,9 @@ QUmlInterfaceRealization::QUmlInterfaceRealization(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInterfaceRealizationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInterfaceRealization. +*/ QModelingElement *QUmlInterfaceRealization::clone() const { QUmlInterfaceRealization *c = new QUmlInterfaceRealization; @@ -105,6 +112,8 @@ QModelingElement *QUmlInterfaceRealization::clone() const /*! References the Interface specifying the conformance contract. + + \b {Subsetted property(ies):} QUmlDependency::suppliers(). */ QUmlInterface *QUmlInterfaceRealization::contract() const { @@ -113,6 +122,9 @@ QUmlInterface *QUmlInterfaceRealization::contract() const return _contract; } +/*! + Adjusts contract to \a contract. + */ void QUmlInterfaceRealization::setContract(QUmlInterface *contract) { // This is a read-write association end @@ -134,6 +146,10 @@ void QUmlInterfaceRealization::setContract(QUmlInterface *contract) /*! References the BehavioredClassifier that owns this Interfacerealization (i.e., the classifier that realizes the Interface to which it points). + + \b {Subsetted property(ies):} QUmlElement::owner(), QUmlDependency::clients(). + + \b {Opposite property(ies):} QUmlBehavioredClassifier::interfaceRealizations(). */ QUmlBehavioredClassifier *QUmlInterfaceRealization::implementingClassifier() const { @@ -142,6 +158,9 @@ QUmlBehavioredClassifier *QUmlInterfaceRealization::implementingClassifier() con return _implementingClassifier; } +/*! + Adjusts implementingClassifier to \a implementingClassifier. + */ void QUmlInterfaceRealization::setImplementingClassifier(QUmlBehavioredClassifier *implementingClassifier) { // This is a read-write association end diff --git a/src/uml/qumlinterfacerealization.h b/src/uml/qumlinterfacerealization.h index 54e2d937..db2f392b 100644 --- a/src/uml/qumlinterfacerealization.h +++ b/src/uml/qumlinterfacerealization.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlRealization> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInterfaceRealization) *) -QT_END_HEADER - #endif // QUMLINTERFACEREALIZATION_H diff --git a/src/uml/qumlinterruptibleactivityregion.cpp b/src/uml/qumlinterruptibleactivityregion.cpp index b2ea6c42..cb2a2384 100644 --- a/src/uml/qumlinterruptibleactivityregion.cpp +++ b/src/uml/qumlinterruptibleactivityregion.cpp @@ -62,12 +62,19 @@ QT_BEGIN_NAMESPACE \brief An interruptible activity region is an activity group that supports termination of tokens flowing in the portions of an activity. */ + +/*! + Creates a new QUmlInterruptibleActivityRegion. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInterruptibleActivityRegion::QUmlInterruptibleActivityRegion(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlInterruptibleActivityRegionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInterruptibleActivityRegion. +*/ QModelingElement *QUmlInterruptibleActivityRegion::clone() const { QUmlInterruptibleActivityRegion *c = new QUmlInterruptibleActivityRegion; @@ -92,6 +99,10 @@ QModelingElement *QUmlInterruptibleActivityRegion::clone() const /*! The edges leaving the region that will abort other tokens flowing in the region. + + \sa addInterruptingEdge(), removeInterruptingEdge() + + \b {Opposite property(ies):} QUmlActivityEdge::interrupts(). */ const QSet<QUmlActivityEdge *> QUmlInterruptibleActivityRegion::interruptingEdges() const { @@ -100,6 +111,11 @@ const QSet<QUmlActivityEdge *> QUmlInterruptibleActivityRegion::interruptingEdge return _interruptingEdges; } +/*! + Adds \a interruptingEdge to interruptingEdges. + + \sa interruptingEdges(), removeInterruptingEdge() + */ void QUmlInterruptibleActivityRegion::addInterruptingEdge(QUmlActivityEdge *interruptingEdge) { // This is a read-write association end @@ -116,6 +132,11 @@ void QUmlInterruptibleActivityRegion::addInterruptingEdge(QUmlActivityEdge *inte } } +/*! + Removes \a interruptingEdge from interruptingEdges. + + \sa interruptingEdges(), addInterruptingEdge() + */ void QUmlInterruptibleActivityRegion::removeInterruptingEdge(QUmlActivityEdge *interruptingEdge) { // This is a read-write association end @@ -132,6 +153,12 @@ void QUmlInterruptibleActivityRegion::removeInterruptingEdge(QUmlActivityEdge *i /*! Nodes immediately contained in the group. + + \sa addNode(), removeNode() + + \b {Subsetted property(ies):} QUmlActivityGroup::containedNodes(). + + \b {Opposite property(ies):} QUmlActivityNode::inInterruptibleRegions(). */ const QSet<QUmlActivityNode *> QUmlInterruptibleActivityRegion::nodes() const { @@ -140,6 +167,11 @@ const QSet<QUmlActivityNode *> QUmlInterruptibleActivityRegion::nodes() const return _nodes; } +/*! + Adds \a node to nodes. + + \sa nodes(), removeNode() + */ void QUmlInterruptibleActivityRegion::addNode(QUmlActivityNode *node) { // This is a read-write association end @@ -159,6 +191,11 @@ void QUmlInterruptibleActivityRegion::addNode(QUmlActivityNode *node) } } +/*! + Removes \a node from nodes. + + \sa nodes(), addNode() + */ void QUmlInterruptibleActivityRegion::removeNode(QUmlActivityNode *node) { // This is a read-write association end diff --git a/src/uml/qumlinterruptibleactivityregion.h b/src/uml/qumlinterruptibleactivityregion.h index 8747ec11..099395ef 100644 --- a/src/uml/qumlinterruptibleactivityregion.h +++ b/src/uml/qumlinterruptibleactivityregion.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlActivityGroup> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -78,7 +76,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInterruptibleActivityRegion) *) -QT_END_HEADER - #endif // QUMLINTERRUPTIBLEACTIVITYREGION_H diff --git a/src/uml/qumlinterval.cpp b/src/uml/qumlinterval.cpp index e9e265a2..7a171830 100644 --- a/src/uml/qumlinterval.cpp +++ b/src/uml/qumlinterval.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief An interval defines the range between two value specifications. */ + +/*! + Creates a new QUmlInterval. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlInterval::QUmlInterval(bool createQModelingObject) : _max(0), _min(0) @@ -70,6 +74,9 @@ QUmlInterval::QUmlInterval(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlIntervalObject(this)); } +/*! + Returns a deep-copied clone of the QUmlInterval. +*/ QModelingElement *QUmlInterval::clone() const { QUmlInterval *c = new QUmlInterval; @@ -106,6 +113,9 @@ QUmlValueSpecification *QUmlInterval::max() const return _max; } +/*! + Adjusts max to \a max. + */ void QUmlInterval::setMax(QUmlValueSpecification *max) { // This is a read-write association end @@ -127,6 +137,9 @@ QUmlValueSpecification *QUmlInterval::min() const return _min; } +/*! + Adjusts min to \a min. + */ void QUmlInterval::setMin(QUmlValueSpecification *min) { // This is a read-write association end diff --git a/src/uml/qumlinterval.h b/src/uml/qumlinterval.h index 86d00b0f..6a058b95 100644 --- a/src/uml/qumlinterval.h +++ b/src/uml/qumlinterval.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlValueSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -73,7 +71,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInterval) *) -QT_END_HEADER - #endif // QUMLINTERVAL_H diff --git a/src/uml/qumlintervalconstraint.cpp b/src/uml/qumlintervalconstraint.cpp index 0607de99..fb188ab8 100644 --- a/src/uml/qumlintervalconstraint.cpp +++ b/src/uml/qumlintervalconstraint.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief An interval constraint is a constraint that refers to an interval. */ + +/*! + Creates a new QUmlIntervalConstraint. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlIntervalConstraint::QUmlIntervalConstraint(bool createQModelingObject) : QUmlConstraint(false), _specification(0) @@ -71,6 +75,9 @@ QUmlIntervalConstraint::QUmlIntervalConstraint(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlIntervalConstraintObject(this)); } +/*! + Returns a deep-copied clone of the QUmlIntervalConstraint. +*/ QModelingElement *QUmlIntervalConstraint::clone() const { QUmlIntervalConstraint *c = new QUmlIntervalConstraint; @@ -99,6 +106,8 @@ QModelingElement *QUmlIntervalConstraint::clone() const /*! A condition that must be true when evaluated in order for the constraint to be satisfied. + + \b {Redefined property(ies):} QUmlConstraint::specification(). */ QUmlInterval *QUmlIntervalConstraint::specification() const { @@ -107,6 +116,9 @@ QUmlInterval *QUmlIntervalConstraint::specification() const return _specification; } +/*! + Adjusts specification to \a specification. + */ void QUmlIntervalConstraint::setSpecification(QUmlInterval *specification) { // This is a read-write association end diff --git a/src/uml/qumlintervalconstraint.h b/src/uml/qumlintervalconstraint.h index 7e520723..b51ae311 100644 --- a/src/uml/qumlintervalconstraint.h +++ b/src/uml/qumlintervalconstraint.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlConstraint> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlIntervalConstraint) *) -QT_END_HEADER - #endif // QUMLINTERVALCONSTRAINT_H diff --git a/src/uml/qumlinvocationaction.cpp b/src/uml/qumlinvocationaction.cpp index 92aa816d..fb0af5ce 100644 --- a/src/uml/qumlinvocationaction.cpp +++ b/src/uml/qumlinvocationaction.cpp @@ -70,12 +70,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief InvocationAction is an abstract class for the various actions that invoke behavior.In addition to targeting an object, invocation actions can also invoke behavioral features on ports from where the invocation requests are routed onwards on links deriving from attached connectors. Invocation actions may also be sent to a target via a given port, either on the sending object or on another object. + + \b {QUmlInvocationAction is an abstract class.} */ + +/*! + Creates a new QUmlInvocationAction. +*/ QUmlInvocationAction::QUmlInvocationAction() : _onPort(0) { } +/*! + Returns a deep-copied clone of the QUmlInvocationAction. +*/ QModelingElement *QUmlInvocationAction::clone() const { QUmlInvocationAction *c = new QUmlInvocationAction; @@ -120,6 +129,10 @@ QModelingElement *QUmlInvocationAction::clone() const /*! Specification of the ordered set of argument values that appears during execution. + + \sa addArgument(), removeArgument() + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ const QList<QUmlInputPin *> QUmlInvocationAction::arguments() const { @@ -128,6 +141,11 @@ const QList<QUmlInputPin *> QUmlInvocationAction::arguments() const return _arguments; } +/*! + Adds \a argument to arguments. + + \sa arguments(), removeArgument() + */ void QUmlInvocationAction::addArgument(QUmlInputPin *argument) { // This is a read-write association end @@ -143,6 +161,11 @@ void QUmlInvocationAction::addArgument(QUmlInputPin *argument) } } +/*! + Removes \a argument from arguments. + + \sa arguments(), addArgument() + */ void QUmlInvocationAction::removeArgument(QUmlInputPin *argument) { // This is a read-write association end @@ -167,6 +190,9 @@ QUmlPort *QUmlInvocationAction::onPort() const return _onPort; } +/*! + Adjusts onPort to \a onPort. + */ void QUmlInvocationAction::setOnPort(QUmlPort *onPort) { // This is a read-write association end diff --git a/src/uml/qumlinvocationaction.h b/src/uml/qumlinvocationaction.h index d06bfea3..e6596a3d 100644 --- a/src/uml/qumlinvocationaction.h +++ b/src/uml/qumlinvocationaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -77,7 +75,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlInvocationAction) *) -QT_END_HEADER - #endif // QUMLINVOCATIONACTION_H diff --git a/src/uml/qumljoinnode.cpp b/src/uml/qumljoinnode.cpp index ec081544..844bd383 100644 --- a/src/uml/qumljoinnode.cpp +++ b/src/uml/qumljoinnode.cpp @@ -69,6 +69,10 @@ QT_BEGIN_NAMESPACE \brief A join node is a control node that synchronizes multiple flows.Join nodes have a Boolean value specification using the names of the incoming edges to specify the conditions under which the join will emit a token. */ + +/*! + Creates a new QUmlJoinNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlJoinNode::QUmlJoinNode(bool createQModelingObject) : _isCombineDuplicate(true), _joinSpec(0) @@ -77,6 +81,9 @@ QUmlJoinNode::QUmlJoinNode(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlJoinNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlJoinNode. +*/ QModelingElement *QUmlJoinNode::clone() const { QUmlJoinNode *c = new QUmlJoinNode; @@ -121,6 +128,9 @@ bool QUmlJoinNode::isCombineDuplicate() const return _isCombineDuplicate; } +/*! + Adjusts isCombineDuplicate to \a isCombineDuplicate. + */ void QUmlJoinNode::setCombineDuplicate(bool isCombineDuplicate) { // This is a read-write property @@ -133,6 +143,8 @@ void QUmlJoinNode::setCombineDuplicate(bool isCombineDuplicate) /*! A specification giving the conditions under which the join with emit a token. Default is 'and'. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlJoinNode::joinSpec() const { @@ -141,6 +153,9 @@ QUmlValueSpecification *QUmlJoinNode::joinSpec() const return _joinSpec; } +/*! + Adjusts joinSpec to \a joinSpec. + */ void QUmlJoinNode::setJoinSpec(QUmlValueSpecification *joinSpec) { // This is a read-write association end diff --git a/src/uml/qumljoinnode.h b/src/uml/qumljoinnode.h index d4aa1f4d..c92cc1c8 100644 --- a/src/uml/qumljoinnode.h +++ b/src/uml/qumljoinnode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlControlNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlJoinNode) *) -QT_END_HEADER - #endif // QUMLJOINNODE_H diff --git a/src/uml/qumllifeline.cpp b/src/uml/qumllifeline.cpp index 5078e47b..78aaf6f0 100644 --- a/src/uml/qumllifeline.cpp +++ b/src/uml/qumllifeline.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief A lifeline represents an individual participant in the interaction. While parts and structural features may have multiplicity greater than 1, lifelines represent only one interacting entity. */ + +/*! + Creates a new QUmlLifeline. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlLifeline::QUmlLifeline(bool createQModelingObject) : _decomposedAs(0), _interaction(0), @@ -73,6 +77,9 @@ QUmlLifeline::QUmlLifeline(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlLifelineObject(this)); } +/*! + Returns a deep-copied clone of the QUmlLifeline. +*/ QModelingElement *QUmlLifeline::clone() const { QUmlLifeline *c = new QUmlLifeline; @@ -101,6 +108,10 @@ QModelingElement *QUmlLifeline::clone() const /*! References the InteractionFragments in which this Lifeline takes part. + + \sa addCoveredBy(), removeCoveredBy() + + \b {Opposite property(ies):} QUmlInteractionFragment::covered(). */ const QSet<QUmlInteractionFragment *> QUmlLifeline::coveredBy() const { @@ -109,6 +120,11 @@ const QSet<QUmlInteractionFragment *> QUmlLifeline::coveredBy() const return _coveredBy; } +/*! + Adds \a coveredBy to coveredBy. + + \sa coveredBy(), removeCoveredBy() + */ void QUmlLifeline::addCoveredBy(QUmlInteractionFragment *coveredBy) { // This is a read-write association end @@ -125,6 +141,11 @@ void QUmlLifeline::addCoveredBy(QUmlInteractionFragment *coveredBy) } } +/*! + Removes \a coveredBy from coveredBy. + + \sa coveredBy(), addCoveredBy() + */ void QUmlLifeline::removeCoveredBy(QUmlInteractionFragment *coveredBy) { // This is a read-write association end @@ -149,6 +170,9 @@ QUmlPartDecomposition *QUmlLifeline::decomposedAs() const return _decomposedAs; } +/*! + Adjusts decomposedAs to \a decomposedAs. + */ void QUmlLifeline::setDecomposedAs(QUmlPartDecomposition *decomposedAs) { // This is a read-write association end @@ -162,6 +186,10 @@ void QUmlLifeline::setDecomposedAs(QUmlPartDecomposition *decomposedAs) /*! References the Interaction enclosing this Lifeline. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlInteraction::lifelines(). */ QUmlInteraction *QUmlLifeline::interaction() const { @@ -170,6 +198,9 @@ QUmlInteraction *QUmlLifeline::interaction() const return _interaction; } +/*! + Adjusts interaction to \a interaction. + */ void QUmlLifeline::setInteraction(QUmlInteraction *interaction) { // This is a read-write association end @@ -196,6 +227,9 @@ QUmlConnectableElement *QUmlLifeline::represents() const return _represents; } +/*! + Adjusts represents to \a represents. + */ void QUmlLifeline::setRepresents(QUmlConnectableElement *represents) { // This is a read-write association end @@ -209,6 +243,8 @@ void QUmlLifeline::setRepresents(QUmlConnectableElement *represents) /*! If the referenced ConnectableElement is multivalued, then this specifies the specific individual part within that set. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlLifeline::selector() const { @@ -217,6 +253,9 @@ QUmlValueSpecification *QUmlLifeline::selector() const return _selector; } +/*! + Adjusts selector to \a selector. + */ void QUmlLifeline::setSelector(QUmlValueSpecification *selector) { // This is a read-write association end diff --git a/src/uml/qumllifeline.h b/src/uml/qumllifeline.h index e4b327f0..57dd0347 100644 --- a/src/uml/qumllifeline.h +++ b/src/uml/qumllifeline.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -89,7 +87,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLifeline) *) -QT_END_HEADER - #endif // QUMLLIFELINE_H diff --git a/src/uml/qumllinkaction.cpp b/src/uml/qumllinkaction.cpp index 70775f5a..78d61a69 100644 --- a/src/uml/qumllinkaction.cpp +++ b/src/uml/qumllinkaction.cpp @@ -71,11 +71,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief LinkAction is an abstract class for all link actions that identify their links by the objects at the ends of the links and by the qualifiers at ends of the links. + + \b {QUmlLinkAction is an abstract class.} */ + +/*! + Creates a new QUmlLinkAction. +*/ QUmlLinkAction::QUmlLinkAction() { } +/*! + Returns a deep-copied clone of the QUmlLinkAction. +*/ QModelingElement *QUmlLinkAction::clone() const { QUmlLinkAction *c = new QUmlLinkAction; @@ -120,6 +129,10 @@ QModelingElement *QUmlLinkAction::clone() const /*! Data identifying one end of a link by the objects on its ends and qualifiers. + + \sa addEndData(), removeEndData() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlLinkEndData *> QUmlLinkAction::endData() const { @@ -128,6 +141,11 @@ const QSet<QUmlLinkEndData *> QUmlLinkAction::endData() const return _endData; } +/*! + Adds \a endData to endData. + + \sa endData(), removeEndData() + */ void QUmlLinkAction::addEndData(QUmlLinkEndData *endData) { // This is a read-write association end @@ -143,6 +161,11 @@ void QUmlLinkAction::addEndData(QUmlLinkEndData *endData) } } +/*! + Removes \a endData from endData. + + \sa endData(), addEndData() + */ void QUmlLinkAction::removeEndData(QUmlLinkEndData *endData) { // This is a read-write association end @@ -159,6 +182,10 @@ void QUmlLinkAction::removeEndData(QUmlLinkEndData *endData) /*! Pins taking end objects and qualifier values as input. + + \sa addInputValue(), removeInputValue() + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ const QSet<QUmlInputPin *> QUmlLinkAction::inputValues() const { @@ -167,6 +194,11 @@ const QSet<QUmlInputPin *> QUmlLinkAction::inputValues() const return _inputValues; } +/*! + Adds \a inputValue to inputValues. + + \sa inputValues(), removeInputValue() + */ void QUmlLinkAction::addInputValue(QUmlInputPin *inputValue) { // This is a read-write association end @@ -182,6 +214,11 @@ void QUmlLinkAction::addInputValue(QUmlInputPin *inputValue) } } +/*! + Removes \a inputValue from inputValues. + + \sa inputValues(), addInputValue() + */ void QUmlLinkAction::removeInputValue(QUmlInputPin *inputValue) { // This is a read-write association end diff --git a/src/uml/qumllinkaction.h b/src/uml/qumllinkaction.h index 31c71b03..120134b5 100644 --- a/src/uml/qumllinkaction.h +++ b/src/uml/qumllinkaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -82,7 +80,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLinkAction) *) -QT_END_HEADER - #endif // QUMLLINKACTION_H diff --git a/src/uml/qumllinkendcreationdata.cpp b/src/uml/qumllinkendcreationdata.cpp index dc0c2537..292983ad 100644 --- a/src/uml/qumllinkendcreationdata.cpp +++ b/src/uml/qumllinkendcreationdata.cpp @@ -57,6 +57,10 @@ QT_BEGIN_NAMESPACE \brief A link end creation data is not an action. It is an element that identifies links. It identifies one end of a link to be created by a create link action. */ + +/*! + Creates a new QUmlLinkEndCreationData. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlLinkEndCreationData::QUmlLinkEndCreationData(bool createQModelingObject) : QUmlLinkEndData(false), _insertAt(0), @@ -66,6 +70,9 @@ QUmlLinkEndCreationData::QUmlLinkEndCreationData(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlLinkEndCreationDataObject(this)); } +/*! + Returns a deep-copied clone of the QUmlLinkEndCreationData. +*/ QModelingElement *QUmlLinkEndCreationData::clone() const { QUmlLinkEndCreationData *c = new QUmlLinkEndCreationData; @@ -95,6 +102,9 @@ QUmlInputPin *QUmlLinkEndCreationData::insertAt() const return _insertAt; } +/*! + Adjusts insertAt to \a insertAt. + */ void QUmlLinkEndCreationData::setInsertAt(QUmlInputPin *insertAt) { // This is a read-write association end @@ -116,6 +126,9 @@ bool QUmlLinkEndCreationData::isReplaceAll() const return _isReplaceAll; } +/*! + Adjusts isReplaceAll to \a isReplaceAll. + */ void QUmlLinkEndCreationData::setReplaceAll(bool isReplaceAll) { // This is a read-write property diff --git a/src/uml/qumllinkendcreationdata.h b/src/uml/qumllinkendcreationdata.h index 468365fb..2330fe05 100644 --- a/src/uml/qumllinkendcreationdata.h +++ b/src/uml/qumllinkendcreationdata.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlLinkEndData> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLinkEndCreationData) *) -QT_END_HEADER - #endif // QUMLLINKENDCREATIONDATA_H diff --git a/src/uml/qumllinkenddata.cpp b/src/uml/qumllinkenddata.cpp index 74a0ae04..69366ad2 100644 --- a/src/uml/qumllinkenddata.cpp +++ b/src/uml/qumllinkenddata.cpp @@ -56,6 +56,10 @@ QT_BEGIN_NAMESPACE \brief A link end data is not an action. It is an element that identifies links. It identifies one end of a link to be read or written by the children of a link action. A link cannot be passed as a runtime value to or from an action. Instead, a link is identified by its end objects and qualifier values, if any. This requires more than one piece of data, namely, the statically-specified end in the user model, the object on the end, and the qualifier values for that end, if any. These pieces are brought together around a link end data. Each association end is identified separately with an instance of the LinkEndData class. */ + +/*! + Creates a new QUmlLinkEndData. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlLinkEndData::QUmlLinkEndData(bool createQModelingObject) : _end(0), _value(0) @@ -64,6 +68,9 @@ QUmlLinkEndData::QUmlLinkEndData(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlLinkEndDataObject(this)); } +/*! + Returns a deep-copied clone of the QUmlLinkEndData. +*/ QModelingElement *QUmlLinkEndData::clone() const { QUmlLinkEndData *c = new QUmlLinkEndData; @@ -90,6 +97,9 @@ QUmlProperty *QUmlLinkEndData::end() const return _end; } +/*! + Adjusts end to \a end. + */ void QUmlLinkEndData::setEnd(QUmlProperty *end) { // This is a read-write association end @@ -103,6 +113,10 @@ void QUmlLinkEndData::setEnd(QUmlProperty *end) /*! List of qualifier values + + \sa addQualifier(), removeQualifier() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlQualifierValue *> QUmlLinkEndData::qualifiers() const { @@ -111,6 +125,11 @@ const QSet<QUmlQualifierValue *> QUmlLinkEndData::qualifiers() const return _qualifiers; } +/*! + Adds \a qualifier to qualifiers. + + \sa qualifiers(), removeQualifier() + */ void QUmlLinkEndData::addQualifier(QUmlQualifierValue *qualifier) { // This is a read-write association end @@ -126,6 +145,11 @@ void QUmlLinkEndData::addQualifier(QUmlQualifierValue *qualifier) } } +/*! + Removes \a qualifier from qualifiers. + + \sa qualifiers(), addQualifier() + */ void QUmlLinkEndData::removeQualifier(QUmlQualifierValue *qualifier) { // This is a read-write association end @@ -150,6 +174,9 @@ QUmlInputPin *QUmlLinkEndData::value() const return _value; } +/*! + Adjusts value to \a value. + */ void QUmlLinkEndData::setValue(QUmlInputPin *value) { // This is a read-write association end diff --git a/src/uml/qumllinkenddata.h b/src/uml/qumllinkenddata.h index e0cd6a42..8d90797c 100644 --- a/src/uml/qumllinkenddata.h +++ b/src/uml/qumllinkenddata.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLinkEndData) *) -QT_END_HEADER - #endif // QUMLLINKENDDATA_H diff --git a/src/uml/qumllinkenddestructiondata.cpp b/src/uml/qumllinkenddestructiondata.cpp index 62d4c415..6c3b6923 100644 --- a/src/uml/qumllinkenddestructiondata.cpp +++ b/src/uml/qumllinkenddestructiondata.cpp @@ -57,6 +57,10 @@ QT_BEGIN_NAMESPACE \brief A link end destruction data is not an action. It is an element that identifies links. It identifies one end of a link to be destroyed by destroy link action. */ + +/*! + Creates a new QUmlLinkEndDestructionData. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlLinkEndDestructionData::QUmlLinkEndDestructionData(bool createQModelingObject) : QUmlLinkEndData(false), _destroyAt(0), @@ -66,6 +70,9 @@ QUmlLinkEndDestructionData::QUmlLinkEndDestructionData(bool createQModelingObjec _qModelingObject = qobject_cast<QModelingObject *>(new QUmlLinkEndDestructionDataObject(this)); } +/*! + Returns a deep-copied clone of the QUmlLinkEndDestructionData. +*/ QModelingElement *QUmlLinkEndDestructionData::clone() const { QUmlLinkEndDestructionData *c = new QUmlLinkEndDestructionData; @@ -95,6 +102,9 @@ QUmlInputPin *QUmlLinkEndDestructionData::destroyAt() const return _destroyAt; } +/*! + Adjusts destroyAt to \a destroyAt. + */ void QUmlLinkEndDestructionData::setDestroyAt(QUmlInputPin *destroyAt) { // This is a read-write association end @@ -116,6 +126,9 @@ bool QUmlLinkEndDestructionData::isDestroyDuplicates() const return _isDestroyDuplicates; } +/*! + Adjusts isDestroyDuplicates to \a isDestroyDuplicates. + */ void QUmlLinkEndDestructionData::setDestroyDuplicates(bool isDestroyDuplicates) { // This is a read-write property diff --git a/src/uml/qumllinkenddestructiondata.h b/src/uml/qumllinkenddestructiondata.h index fbe11846..74930aae 100644 --- a/src/uml/qumllinkenddestructiondata.h +++ b/src/uml/qumllinkenddestructiondata.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlLinkEndData> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLinkEndDestructionData) *) -QT_END_HEADER - #endif // QUMLLINKENDDESTRUCTIONDATA_H diff --git a/src/uml/qumlliteralboolean.cpp b/src/uml/qumlliteralboolean.cpp index 5c5b1be3..06af3298 100644 --- a/src/uml/qumlliteralboolean.cpp +++ b/src/uml/qumlliteralboolean.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief A literal Boolean is a specification of a Boolean value. */ + +/*! + Creates a new QUmlLiteralBoolean. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlLiteralBoolean::QUmlLiteralBoolean(bool createQModelingObject) : _value(false) { @@ -69,6 +73,9 @@ QUmlLiteralBoolean::QUmlLiteralBoolean(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlLiteralBooleanObject(this)); } +/*! + Returns a deep-copied clone of the QUmlLiteralBoolean. +*/ QModelingElement *QUmlLiteralBoolean::clone() const { QUmlLiteralBoolean *c = new QUmlLiteralBoolean; @@ -102,6 +109,9 @@ bool QUmlLiteralBoolean::value() const return _value; } +/*! + Adjusts value to \a value. + */ void QUmlLiteralBoolean::setValue(bool value) { // This is a read-write property diff --git a/src/uml/qumlliteralboolean.h b/src/uml/qumlliteralboolean.h index a01322a4..075e8279 100644 --- a/src/uml/qumlliteralboolean.h +++ b/src/uml/qumlliteralboolean.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlLiteralSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -74,7 +72,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLiteralBoolean) *) -QT_END_HEADER - #endif // QUMLLITERALBOOLEAN_H diff --git a/src/uml/qumlliteralinteger.cpp b/src/uml/qumlliteralinteger.cpp index 8f29594e..c7201499 100644 --- a/src/uml/qumlliteralinteger.cpp +++ b/src/uml/qumlliteralinteger.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief A literal integer is a specification of an integer value. */ + +/*! + Creates a new QUmlLiteralInteger. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlLiteralInteger::QUmlLiteralInteger(bool createQModelingObject) : _value(0) { @@ -69,6 +73,9 @@ QUmlLiteralInteger::QUmlLiteralInteger(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlLiteralIntegerObject(this)); } +/*! + Returns a deep-copied clone of the QUmlLiteralInteger. +*/ QModelingElement *QUmlLiteralInteger::clone() const { QUmlLiteralInteger *c = new QUmlLiteralInteger; @@ -102,6 +109,9 @@ int QUmlLiteralInteger::value() const return _value; } +/*! + Adjusts value to \a value. + */ void QUmlLiteralInteger::setValue(int value) { // This is a read-write property diff --git a/src/uml/qumlliteralinteger.h b/src/uml/qumlliteralinteger.h index 96f27f35..85c726e6 100644 --- a/src/uml/qumlliteralinteger.h +++ b/src/uml/qumlliteralinteger.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlLiteralSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -74,7 +72,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLiteralInteger) *) -QT_END_HEADER - #endif // QUMLLITERALINTEGER_H diff --git a/src/uml/qumlliteralnull.cpp b/src/uml/qumlliteralnull.cpp index 41313622..f755a870 100644 --- a/src/uml/qumlliteralnull.cpp +++ b/src/uml/qumlliteralnull.cpp @@ -62,12 +62,19 @@ QT_BEGIN_NAMESPACE \brief A literal null specifies the lack of a value. */ + +/*! + Creates a new QUmlLiteralNull. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlLiteralNull::QUmlLiteralNull(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlLiteralNullObject(this)); } +/*! + Returns a deep-copied clone of the QUmlLiteralNull. +*/ QModelingElement *QUmlLiteralNull::clone() const { QUmlLiteralNull *c = new QUmlLiteralNull; diff --git a/src/uml/qumlliteralnull.h b/src/uml/qumlliteralnull.h index 19b3cedd..d771f237 100644 --- a/src/uml/qumlliteralnull.h +++ b/src/uml/qumlliteralnull.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlLiteralSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -70,7 +68,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLiteralNull) *) -QT_END_HEADER - #endif // QUMLLITERALNULL_H diff --git a/src/uml/qumlliteralreal.cpp b/src/uml/qumlliteralreal.cpp index 9c2c40c8..5232583f 100644 --- a/src/uml/qumlliteralreal.cpp +++ b/src/uml/qumlliteralreal.cpp @@ -62,12 +62,19 @@ QT_BEGIN_NAMESPACE \brief A literal real is a specification of a real value. */ + +/*! + Creates a new QUmlLiteralReal. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlLiteralReal::QUmlLiteralReal(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlLiteralRealObject(this)); } +/*! + Returns a deep-copied clone of the QUmlLiteralReal. +*/ QModelingElement *QUmlLiteralReal::clone() const { QUmlLiteralReal *c = new QUmlLiteralReal; @@ -91,7 +98,6 @@ QModelingElement *QUmlLiteralReal::clone() const // OWNED ATTRIBUTES - double QUmlLiteralReal::value() const { // This is a read-write property diff --git a/src/uml/qumlliteralreal.h b/src/uml/qumlliteralreal.h index e778fabd..bffe4882 100644 --- a/src/uml/qumlliteralreal.h +++ b/src/uml/qumlliteralreal.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlLiteralSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -74,7 +72,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLiteralReal) *) -QT_END_HEADER - #endif // QUMLLITERALREAL_H diff --git a/src/uml/qumlliteralspecification.cpp b/src/uml/qumlliteralspecification.cpp index 5f00a4bf..de4968c2 100644 --- a/src/uml/qumlliteralspecification.cpp +++ b/src/uml/qumlliteralspecification.cpp @@ -59,11 +59,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A literal specification identifies a literal constant being modeled. + + \b {QUmlLiteralSpecification is an abstract class.} */ + +/*! + Creates a new QUmlLiteralSpecification. +*/ QUmlLiteralSpecification::QUmlLiteralSpecification() { } +/*! + Returns a deep-copied clone of the QUmlLiteralSpecification. +*/ QModelingElement *QUmlLiteralSpecification::clone() const { QUmlLiteralSpecification *c = new QUmlLiteralSpecification; diff --git a/src/uml/qumlliteralspecification.h b/src/uml/qumlliteralspecification.h index 03fe3a50..b631a5b0 100644 --- a/src/uml/qumlliteralspecification.h +++ b/src/uml/qumlliteralspecification.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlValueSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLiteralSpecification) *) -QT_END_HEADER - #endif // QUMLLITERALSPECIFICATION_H diff --git a/src/uml/qumlliteralstring.cpp b/src/uml/qumlliteralstring.cpp index c2e651e7..6f4b8665 100644 --- a/src/uml/qumlliteralstring.cpp +++ b/src/uml/qumlliteralstring.cpp @@ -62,12 +62,19 @@ QT_BEGIN_NAMESPACE \brief A literal string is a specification of a string value. */ + +/*! + Creates a new QUmlLiteralString. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlLiteralString::QUmlLiteralString(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlLiteralStringObject(this)); } +/*! + Returns a deep-copied clone of the QUmlLiteralString. +*/ QModelingElement *QUmlLiteralString::clone() const { QUmlLiteralString *c = new QUmlLiteralString; @@ -101,6 +108,9 @@ QString QUmlLiteralString::value() const return _value; } +/*! + Adjusts value to \a value. + */ void QUmlLiteralString::setValue(QString value) { // This is a read-write property diff --git a/src/uml/qumlliteralstring.h b/src/uml/qumlliteralstring.h index 5443c5c0..e0755ec5 100644 --- a/src/uml/qumlliteralstring.h +++ b/src/uml/qumlliteralstring.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlLiteralSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -74,7 +72,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLiteralString) *) -QT_END_HEADER - #endif // QUMLLITERALSTRING_H diff --git a/src/uml/qumlliteralunlimitednatural.cpp b/src/uml/qumlliteralunlimitednatural.cpp index b2671884..4d500cfe 100644 --- a/src/uml/qumlliteralunlimitednatural.cpp +++ b/src/uml/qumlliteralunlimitednatural.cpp @@ -62,12 +62,19 @@ QT_BEGIN_NAMESPACE \brief A literal unlimited natural is a specification of an unlimited natural number. */ + +/*! + Creates a new QUmlLiteralUnlimitedNatural. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlLiteralUnlimitedNatural::QUmlLiteralUnlimitedNatural(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlLiteralUnlimitedNaturalObject(this)); } +/*! + Returns a deep-copied clone of the QUmlLiteralUnlimitedNatural. +*/ QModelingElement *QUmlLiteralUnlimitedNatural::clone() const { QUmlLiteralUnlimitedNatural *c = new QUmlLiteralUnlimitedNatural; @@ -101,6 +108,9 @@ QString QUmlLiteralUnlimitedNatural::value() const return _value; } +/*! + Adjusts value to \a value. + */ void QUmlLiteralUnlimitedNatural::setValue(QString value) { // This is a read-write property diff --git a/src/uml/qumlliteralunlimitednatural.h b/src/uml/qumlliteralunlimitednatural.h index 7815fe66..91e66da3 100644 --- a/src/uml/qumlliteralunlimitednatural.h +++ b/src/uml/qumlliteralunlimitednatural.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlLiteralSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -74,7 +72,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLiteralUnlimitedNatural) *) -QT_END_HEADER - #endif // QUMLLITERALUNLIMITEDNATURAL_H diff --git a/src/uml/qumlloopnode.cpp b/src/uml/qumlloopnode.cpp index d2188cc1..ac585b5d 100644 --- a/src/uml/qumlloopnode.cpp +++ b/src/uml/qumlloopnode.cpp @@ -76,6 +76,10 @@ QT_BEGIN_NAMESPACE \brief A loop node is a structured activity node that represents a loop with setup, test, and body sections. */ + +/*! + Creates a new QUmlLoopNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlLoopNode::QUmlLoopNode(bool createQModelingObject) : QUmlStructuredActivityNode(false), _decider(0), @@ -85,6 +89,9 @@ QUmlLoopNode::QUmlLoopNode(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlLoopNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlLoopNode. +*/ QModelingElement *QUmlLoopNode::clone() const { QUmlLoopNode *c = new QUmlLoopNode; @@ -155,6 +162,8 @@ QModelingElement *QUmlLoopNode::clone() const /*! A list of output pins within the body fragment the values of which are moved to the loop variable pins after completion of execution of the body, before the next iteration of the loop begins or before the loop exits. + + \sa addBodyOutput(), removeBodyOutput() */ const QList<QUmlOutputPin *> QUmlLoopNode::bodyOutputs() const { @@ -163,6 +172,11 @@ const QList<QUmlOutputPin *> QUmlLoopNode::bodyOutputs() const return _bodyOutputs; } +/*! + Adds \a bodyOutput to bodyOutputs. + + \sa bodyOutputs(), removeBodyOutput() + */ void QUmlLoopNode::addBodyOutput(QUmlOutputPin *bodyOutput) { // This is a read-write association end @@ -174,6 +188,11 @@ void QUmlLoopNode::addBodyOutput(QUmlOutputPin *bodyOutput) } } +/*! + Removes \a bodyOutput from bodyOutputs. + + \sa bodyOutputs(), addBodyOutput() + */ void QUmlLoopNode::removeBodyOutput(QUmlOutputPin *bodyOutput) { // This is a read-write association end @@ -185,6 +204,8 @@ void QUmlLoopNode::removeBodyOutput(QUmlOutputPin *bodyOutput) /*! The set of nodes and edges that perform the repetitive computations of the loop. The body section is executed as long as the test section produces a true value. + + \sa addBodyPart(), removeBodyPart() */ const QSet<QUmlExecutableNode *> QUmlLoopNode::bodyParts() const { @@ -193,6 +214,11 @@ const QSet<QUmlExecutableNode *> QUmlLoopNode::bodyParts() const return _bodyParts; } +/*! + Adds \a bodyPart to bodyParts. + + \sa bodyParts(), removeBodyPart() + */ void QUmlLoopNode::addBodyPart(QUmlExecutableNode *bodyPart) { // This is a read-write association end @@ -204,6 +230,11 @@ void QUmlLoopNode::addBodyPart(QUmlExecutableNode *bodyPart) } } +/*! + Removes \a bodyPart from bodyParts. + + \sa bodyParts(), addBodyPart() + */ void QUmlLoopNode::removeBodyPart(QUmlExecutableNode *bodyPart) { // This is a read-write association end @@ -223,6 +254,9 @@ QUmlOutputPin *QUmlLoopNode::decider() const return _decider; } +/*! + Adjusts decider to \a decider. + */ void QUmlLoopNode::setDecider(QUmlOutputPin *decider) { // This is a read-write association end @@ -244,6 +278,9 @@ bool QUmlLoopNode::isTestedFirst() const return _isTestedFirst; } +/*! + Adjusts isTestedFirst to \a isTestedFirst. + */ void QUmlLoopNode::setTestedFirst(bool isTestedFirst) { // This is a read-write property @@ -256,6 +293,8 @@ void QUmlLoopNode::setTestedFirst(bool isTestedFirst) /*! A list of output pins that hold the values of the loop variables during an execution of the loop. When the test fails, the values are movied to the result pins of the loop. + + \sa addLoopVariable(), removeLoopVariable() */ const QList<QUmlOutputPin *> QUmlLoopNode::loopVariables() const { @@ -264,6 +303,11 @@ const QList<QUmlOutputPin *> QUmlLoopNode::loopVariables() const return _loopVariables; } +/*! + Adds \a loopVariable to loopVariables. + + \sa loopVariables(), removeLoopVariable() + */ void QUmlLoopNode::addLoopVariable(QUmlOutputPin *loopVariable) { // This is a read-write association end @@ -275,6 +319,11 @@ void QUmlLoopNode::addLoopVariable(QUmlOutputPin *loopVariable) } } +/*! + Removes \a loopVariable from loopVariables. + + \sa loopVariables(), addLoopVariable() + */ void QUmlLoopNode::removeLoopVariable(QUmlOutputPin *loopVariable) { // This is a read-write association end @@ -286,6 +335,10 @@ void QUmlLoopNode::removeLoopVariable(QUmlOutputPin *loopVariable) /*! A list of values that are moved into the loop variable pins before the first iteration of the loop. + + \sa addLoopVariableInput(), removeLoopVariableInput() + + \b {Redefined property(ies):} QUmlStructuredActivityNode::structuredNodeInputs(). */ const QList<QUmlInputPin *> QUmlLoopNode::loopVariableInputs() const { @@ -294,6 +347,11 @@ const QList<QUmlInputPin *> QUmlLoopNode::loopVariableInputs() const return _loopVariableInputs; } +/*! + Adds \a loopVariableInput to loopVariableInputs. + + \sa loopVariableInputs(), removeLoopVariableInput() + */ void QUmlLoopNode::addLoopVariableInput(QUmlInputPin *loopVariableInput) { // This is a read-write association end @@ -309,6 +367,11 @@ void QUmlLoopNode::addLoopVariableInput(QUmlInputPin *loopVariableInput) } } +/*! + Removes \a loopVariableInput from loopVariableInputs. + + \sa loopVariableInputs(), addLoopVariableInput() + */ void QUmlLoopNode::removeLoopVariableInput(QUmlInputPin *loopVariableInput) { // This is a read-write association end @@ -325,6 +388,10 @@ void QUmlLoopNode::removeLoopVariableInput(QUmlInputPin *loopVariableInput) /*! A list of output pins that constitute the data flow output of the entire loop. + + \sa addResult(), removeResult() + + \b {Redefined property(ies):} QUmlStructuredActivityNode::structuredNodeOutputs(). */ const QList<QUmlOutputPin *> QUmlLoopNode::results() const { @@ -333,6 +400,11 @@ const QList<QUmlOutputPin *> QUmlLoopNode::results() const return _results; } +/*! + Adds \a result to results. + + \sa results(), removeResult() + */ void QUmlLoopNode::addResult(QUmlOutputPin *result) { // This is a read-write association end @@ -348,6 +420,11 @@ void QUmlLoopNode::addResult(QUmlOutputPin *result) } } +/*! + Removes \a result from results. + + \sa results(), addResult() + */ void QUmlLoopNode::removeResult(QUmlOutputPin *result) { // This is a read-write association end @@ -364,6 +441,8 @@ void QUmlLoopNode::removeResult(QUmlOutputPin *result) /*! The set of nodes and edges that initialize values or perform other setup computations for the loop. + + \sa addSetupPart(), removeSetupPart() */ const QSet<QUmlExecutableNode *> QUmlLoopNode::setupParts() const { @@ -372,6 +451,11 @@ const QSet<QUmlExecutableNode *> QUmlLoopNode::setupParts() const return _setupParts; } +/*! + Adds \a setupPart to setupParts. + + \sa setupParts(), removeSetupPart() + */ void QUmlLoopNode::addSetupPart(QUmlExecutableNode *setupPart) { // This is a read-write association end @@ -383,6 +467,11 @@ void QUmlLoopNode::addSetupPart(QUmlExecutableNode *setupPart) } } +/*! + Removes \a setupPart from setupParts. + + \sa setupParts(), addSetupPart() + */ void QUmlLoopNode::removeSetupPart(QUmlExecutableNode *setupPart) { // This is a read-write association end @@ -394,6 +483,8 @@ void QUmlLoopNode::removeSetupPart(QUmlExecutableNode *setupPart) /*! The set of nodes, edges, and designated value that compute a Boolean value to determine if another execution of the body will be performed. + + \sa addTest(), removeTest() */ const QSet<QUmlExecutableNode *> QUmlLoopNode::tests() const { @@ -402,6 +493,11 @@ const QSet<QUmlExecutableNode *> QUmlLoopNode::tests() const return _tests; } +/*! + Adds \a test to tests. + + \sa tests(), removeTest() + */ void QUmlLoopNode::addTest(QUmlExecutableNode *test) { // This is a read-write association end @@ -413,6 +509,11 @@ void QUmlLoopNode::addTest(QUmlExecutableNode *test) } } +/*! + Removes \a test from tests. + + \sa tests(), addTest() + */ void QUmlLoopNode::removeTest(QUmlExecutableNode *test) { // This is a read-write association end diff --git a/src/uml/qumlloopnode.h b/src/uml/qumlloopnode.h index e1cbdd78..24bab808 100644 --- a/src/uml/qumlloopnode.h +++ b/src/uml/qumlloopnode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlStructuredActivityNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -105,7 +103,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlLoopNode) *) -QT_END_HEADER - #endif // QUMLLOOPNODE_H diff --git a/src/uml/qumlmanifestation.cpp b/src/uml/qumlmanifestation.cpp index fb6bbe99..500545ca 100644 --- a/src/uml/qumlmanifestation.cpp +++ b/src/uml/qumlmanifestation.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief A manifestation is the concrete physical rendering of one or more model elements by an artifact. */ + +/*! + Creates a new QUmlManifestation. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlManifestation::QUmlManifestation(bool createQModelingObject) : QUmlAbstraction(false), _utilizedElement(0) @@ -71,6 +75,9 @@ QUmlManifestation::QUmlManifestation(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlManifestationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlManifestation. +*/ QModelingElement *QUmlManifestation::clone() const { QUmlManifestation *c = new QUmlManifestation; @@ -101,6 +108,8 @@ QModelingElement *QUmlManifestation::clone() const /*! The model element that is utilized in the manifestation in an Artifact. + + \b {Subsetted property(ies):} QUmlDependency::suppliers(). */ QUmlPackageableElement *QUmlManifestation::utilizedElement() const { @@ -109,6 +118,9 @@ QUmlPackageableElement *QUmlManifestation::utilizedElement() const return _utilizedElement; } +/*! + Adjusts utilizedElement to \a utilizedElement. + */ void QUmlManifestation::setUtilizedElement(QUmlPackageableElement *utilizedElement) { // This is a read-write association end diff --git a/src/uml/qumlmanifestation.h b/src/uml/qumlmanifestation.h index a81fafe1..a019d3c8 100644 --- a/src/uml/qumlmanifestation.h +++ b/src/uml/qumlmanifestation.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAbstraction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlManifestation) *) -QT_END_HEADER - #endif // QUMLMANIFESTATION_H diff --git a/src/uml/qumlmergenode.cpp b/src/uml/qumlmergenode.cpp index 7198dafc..79a1b7e1 100644 --- a/src/uml/qumlmergenode.cpp +++ b/src/uml/qumlmergenode.cpp @@ -68,12 +68,19 @@ QT_BEGIN_NAMESPACE \brief A merge node is a control node that brings together multiple alternate flows. It is not used to synchronize concurrent flows but to accept one among several alternate flows. */ + +/*! + Creates a new QUmlMergeNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlMergeNode::QUmlMergeNode(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlMergeNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlMergeNode. +*/ QModelingElement *QUmlMergeNode::clone() const { QUmlMergeNode *c = new QUmlMergeNode; diff --git a/src/uml/qumlmergenode.h b/src/uml/qumlmergenode.h index 52b337d0..d0b95380 100644 --- a/src/uml/qumlmergenode.h +++ b/src/uml/qumlmergenode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlControlNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlMergeNode) *) -QT_END_HEADER - #endif // QUMLMERGENODE_H diff --git a/src/uml/qumlmessage.cpp b/src/uml/qumlmessage.cpp index cdc147d4..e971cf2a 100644 --- a/src/uml/qumlmessage.cpp +++ b/src/uml/qumlmessage.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief A message defines a particular communication between lifelines of an interaction. */ + +/*! + Creates a new QUmlMessage. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlMessage::QUmlMessage(bool createQModelingObject) : _connector(0), _interaction(0), @@ -74,6 +78,9 @@ QUmlMessage::QUmlMessage(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlMessageObject(this)); } +/*! + Returns a deep-copied clone of the QUmlMessage. +*/ QModelingElement *QUmlMessage::clone() const { QUmlMessage *c = new QUmlMessage; @@ -105,6 +112,10 @@ QModelingElement *QUmlMessage::clone() const /*! The arguments of the Message + + \sa addArgument(), removeArgument() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QList<QUmlValueSpecification *> QUmlMessage::arguments() const { @@ -113,6 +124,11 @@ const QList<QUmlValueSpecification *> QUmlMessage::arguments() const return _arguments; } +/*! + Adds \a argument to arguments. + + \sa arguments(), removeArgument() + */ void QUmlMessage::addArgument(QUmlValueSpecification *argument) { // This is a read-write association end @@ -128,6 +144,11 @@ void QUmlMessage::addArgument(QUmlValueSpecification *argument) } } +/*! + Removes \a argument from arguments. + + \sa arguments(), addArgument() + */ void QUmlMessage::removeArgument(QUmlValueSpecification *argument) { // This is a read-write association end @@ -152,6 +173,9 @@ QUmlConnector *QUmlMessage::connector() const return _connector; } +/*! + Adjusts connector to \a connector. + */ void QUmlMessage::setConnector(QUmlConnector *connector) { // This is a read-write association end @@ -165,6 +189,10 @@ void QUmlMessage::setConnector(QUmlConnector *connector) /*! The enclosing Interaction owning the Message + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlInteraction::messages(). */ QUmlInteraction *QUmlMessage::interaction() const { @@ -173,6 +201,9 @@ QUmlInteraction *QUmlMessage::interaction() const return _interaction; } +/*! + Adjusts interaction to \a interaction. + */ void QUmlMessage::setInteraction(QUmlInteraction *interaction) { // This is a read-write association end @@ -191,6 +222,8 @@ void QUmlMessage::setInteraction(QUmlInteraction *interaction) /*! The derived kind of the Message (complete, lost, found or unknown) + + \b {This is a read-only derived property.} */ QtUml::MessageKind QUmlMessage::messageKind() const { @@ -201,6 +234,9 @@ QtUml::MessageKind QUmlMessage::messageKind() const return QtUml::MessageKind(); } +/*! + Adjusts messageKind to \a messageKind. + */ void QUmlMessage::setMessageKind(QtUml::MessageKind messageKind) { // This is a read-only derived property @@ -223,6 +259,9 @@ QtUml::MessageSort QUmlMessage::messageSort() const return _messageSort; } +/*! + Adjusts messageSort to \a messageSort. + */ void QUmlMessage::setMessageSort(QtUml::MessageSort messageSort) { // This is a read-write property @@ -235,6 +274,8 @@ void QUmlMessage::setMessageSort(QtUml::MessageSort messageSort) /*! References the Receiving of the Message + + \b {Subsetted property(ies):} . */ QUmlMessageEnd *QUmlMessage::receiveEvent() const { @@ -243,6 +284,9 @@ QUmlMessageEnd *QUmlMessage::receiveEvent() const return _receiveEvent; } +/*! + Adjusts receiveEvent to \a receiveEvent. + */ void QUmlMessage::setReceiveEvent(QUmlMessageEnd *receiveEvent) { // This is a read-write association end @@ -256,6 +300,8 @@ void QUmlMessage::setReceiveEvent(QUmlMessageEnd *receiveEvent) /*! References the Sending of the Message. + + \b {Subsetted property(ies):} . */ QUmlMessageEnd *QUmlMessage::sendEvent() const { @@ -264,6 +310,9 @@ QUmlMessageEnd *QUmlMessage::sendEvent() const return _sendEvent; } +/*! + Adjusts sendEvent to \a sendEvent. + */ void QUmlMessage::setSendEvent(QUmlMessageEnd *sendEvent) { // This is a read-write association end @@ -285,6 +334,9 @@ QUmlNamedElement *QUmlMessage::signature() const return _signature; } +/*! + Adjusts signature to \a signature. + */ void QUmlMessage::setSignature(QUmlNamedElement *signature) { // This is a read-write association end diff --git a/src/uml/qumlmessage.h b/src/uml/qumlmessage.h index 29e305a2..8577e9fe 100644 --- a/src/uml/qumlmessage.h +++ b/src/uml/qumlmessage.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -98,7 +96,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlMessage) *) -QT_END_HEADER - #endif // QUMLMESSAGE_H diff --git a/src/uml/qumlmessageend.cpp b/src/uml/qumlmessageend.cpp index c2671275..89fd6fe5 100644 --- a/src/uml/qumlmessageend.cpp +++ b/src/uml/qumlmessageend.cpp @@ -56,12 +56,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief MessageEnd is an abstract specialization of NamedElement that represents what can occur at the end of a message. + + \b {QUmlMessageEnd is an abstract class.} */ + +/*! + Creates a new QUmlMessageEnd. +*/ QUmlMessageEnd::QUmlMessageEnd() : _message(0) { } +/*! + Returns a deep-copied clone of the QUmlMessageEnd. +*/ QModelingElement *QUmlMessageEnd::clone() const { QUmlMessageEnd *c = new QUmlMessageEnd; @@ -90,6 +99,9 @@ QUmlMessage *QUmlMessageEnd::message() const return _message; } +/*! + Adjusts message to \a message. + */ void QUmlMessageEnd::setMessage(QUmlMessage *message) { // This is a read-write association end diff --git a/src/uml/qumlmessageend.h b/src/uml/qumlmessageend.h index de78c5d6..1a2dde88 100644 --- a/src/uml/qumlmessageend.h +++ b/src/uml/qumlmessageend.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlMessageEnd) *) -QT_END_HEADER - #endif // QUMLMESSAGEEND_H diff --git a/src/uml/qumlmessageevent.cpp b/src/uml/qumlmessageevent.cpp index babdd126..1917f0c1 100644 --- a/src/uml/qumlmessageevent.cpp +++ b/src/uml/qumlmessageevent.cpp @@ -58,11 +58,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A message event specifies the receipt by an object of either a call or a signal. + + \b {QUmlMessageEvent is an abstract class.} */ + +/*! + Creates a new QUmlMessageEvent. +*/ QUmlMessageEvent::QUmlMessageEvent() { } +/*! + Returns a deep-copied clone of the QUmlMessageEvent. +*/ QModelingElement *QUmlMessageEvent::clone() const { QUmlMessageEvent *c = new QUmlMessageEvent; diff --git a/src/uml/qumlmessageevent.h b/src/uml/qumlmessageevent.h index a28162c1..f868c23b 100644 --- a/src/uml/qumlmessageevent.h +++ b/src/uml/qumlmessageevent.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlEvent> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlMessageEvent) *) -QT_END_HEADER - #endif // QUMLMESSAGEEVENT_H diff --git a/src/uml/qumlmessageoccurrencespecification.cpp b/src/uml/qumlmessageoccurrencespecification.cpp index c225bd9d..bb4bccf3 100644 --- a/src/uml/qumlmessageoccurrencespecification.cpp +++ b/src/uml/qumlmessageoccurrencespecification.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief A message occurrence specification pecifies the occurrence of message events, such as sending and receiving of signals or invoking or receiving of operation calls. A message occurrence specification is a kind of message end. Messages are generated either by synchronous operation calls or asynchronous signal sends. They are received by the execution of corresponding accept event actions. */ + +/*! + Creates a new QUmlMessageOccurrenceSpecification. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlMessageOccurrenceSpecification::QUmlMessageOccurrenceSpecification(bool createQModelingObject) : QUmlOccurrenceSpecification(false) { @@ -71,6 +75,9 @@ QUmlMessageOccurrenceSpecification::QUmlMessageOccurrenceSpecification(bool crea _qModelingObject = qobject_cast<QModelingObject *>(new QUmlMessageOccurrenceSpecificationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlMessageOccurrenceSpecification. +*/ QModelingElement *QUmlMessageOccurrenceSpecification::clone() const { QUmlMessageOccurrenceSpecification *c = new QUmlMessageOccurrenceSpecification; diff --git a/src/uml/qumlmessageoccurrencespecification.h b/src/uml/qumlmessageoccurrencespecification.h index 6498b3e4..a9441478 100644 --- a/src/uml/qumlmessageoccurrencespecification.h +++ b/src/uml/qumlmessageoccurrencespecification.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlOccurrenceSpecification> #include <QtUml/QUmlMessageEnd> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -67,7 +65,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlMessageOccurrenceSpecification) *) -QT_END_HEADER - #endif // QUMLMESSAGEOCCURRENCESPECIFICATION_H diff --git a/src/uml/qumlmodel.cpp b/src/uml/qumlmodel.cpp index 725fd6e9..10056722 100644 --- a/src/uml/qumlmodel.cpp +++ b/src/uml/qumlmodel.cpp @@ -71,6 +71,10 @@ QT_BEGIN_NAMESPACE \brief A model captures a view of a physical system. It is an abstraction of the physical system, with a certain purpose. This purpose determines what is to be included in the model and what is irrelevant. Thus the model completely describes those aspects of the physical system that are relevant to the purpose of the model, at the appropriate level of detail. */ + +/*! + Creates a new QUmlModel. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlModel::QUmlModel(bool createQModelingObject) : QUmlPackage(false) { @@ -78,6 +82,9 @@ QUmlModel::QUmlModel(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlModelObject(this)); } +/*! + Returns a deep-copied clone of the QUmlModel. +*/ QModelingElement *QUmlModel::clone() const { QUmlModel *c = new QUmlModel; @@ -128,6 +135,9 @@ QString QUmlModel::viewpoint() const return _viewpoint; } +/*! + Adjusts viewpoint to \a viewpoint. + */ void QUmlModel::setViewpoint(QString viewpoint) { // This is a read-write property diff --git a/src/uml/qumlmodel.h b/src/uml/qumlmodel.h index 097b16fc..6e3558e3 100644 --- a/src/uml/qumlmodel.h +++ b/src/uml/qumlmodel.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlPackage> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -70,7 +68,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlModel) *) -QT_END_HEADER - #endif // QUMLMODEL_H diff --git a/src/uml/qumlmultiplicityelement.cpp b/src/uml/qumlmultiplicityelement.cpp index aa042929..76438ba0 100644 --- a/src/uml/qumlmultiplicityelement.cpp +++ b/src/uml/qumlmultiplicityelement.cpp @@ -51,7 +51,13 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A multiplicity is a definition of an inclusive interval of non-negative integers beginning with a lower bound and ending with a (possibly infinite) upper bound. A multiplicity element embeds this information to specify the allowable cardinalities for an instantiation of this element. + + \b {QUmlMultiplicityElement is an abstract class.} */ + +/*! + Creates a new QUmlMultiplicityElement. +*/ QUmlMultiplicityElement::QUmlMultiplicityElement() : _isOrdered(false), _isUnique(true), @@ -60,6 +66,9 @@ QUmlMultiplicityElement::QUmlMultiplicityElement() : { } +/*! + Returns a deep-copied clone of the QUmlMultiplicityElement. +*/ QModelingElement *QUmlMultiplicityElement::clone() const { QUmlMultiplicityElement *c = new QUmlMultiplicityElement; @@ -86,6 +95,9 @@ bool QUmlMultiplicityElement::isOrdered() const return _isOrdered; } +/*! + Adjusts isOrdered to \a isOrdered. + */ void QUmlMultiplicityElement::setOrdered(bool isOrdered) { // This is a read-write property @@ -106,6 +118,9 @@ bool QUmlMultiplicityElement::isUnique() const return _isUnique; } +/*! + Adjusts isUnique to \a isUnique. + */ void QUmlMultiplicityElement::setUnique(bool isUnique) { // This is a read-write property @@ -118,6 +133,8 @@ void QUmlMultiplicityElement::setUnique(bool isUnique) /*! Specifies the lower bound of the multiplicity interval. + + \b {This is a derived property.} */ int QUmlMultiplicityElement::lower() const { @@ -128,6 +145,9 @@ int QUmlMultiplicityElement::lower() const return int(); } +/*! + Adjusts lower to \a lower. + */ void QUmlMultiplicityElement::setLower(int lower) { // This is a read-write derived property @@ -142,6 +162,8 @@ void QUmlMultiplicityElement::setLower(int lower) /*! The specification of the lower bound for this multiplicity. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlMultiplicityElement::lowerValue() const { @@ -150,6 +172,9 @@ QUmlValueSpecification *QUmlMultiplicityElement::lowerValue() const return _lowerValue; } +/*! + Adjusts lowerValue to \a lowerValue. + */ void QUmlMultiplicityElement::setLowerValue(QUmlValueSpecification *lowerValue) { // This is a read-write association end @@ -172,6 +197,8 @@ void QUmlMultiplicityElement::setLowerValue(QUmlValueSpecification *lowerValue) /*! Specifies the upper bound of the multiplicity interval. + + \b {This is a derived property.} */ QString QUmlMultiplicityElement::upper() const { @@ -182,6 +209,9 @@ QString QUmlMultiplicityElement::upper() const return QString(); } +/*! + Adjusts upper to \a upper. + */ void QUmlMultiplicityElement::setUpper(QString upper) { // This is a read-write derived property @@ -196,6 +226,8 @@ void QUmlMultiplicityElement::setUpper(QString upper) /*! The specification of the upper bound for this multiplicity. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlMultiplicityElement::upperValue() const { @@ -204,6 +236,9 @@ QUmlValueSpecification *QUmlMultiplicityElement::upperValue() const return _upperValue; } +/*! + Adjusts upperValue to \a upperValue. + */ void QUmlMultiplicityElement::setUpperValue(QUmlValueSpecification *upperValue) { // This is a read-write association end diff --git a/src/uml/qumlmultiplicityelement.h b/src/uml/qumlmultiplicityelement.h index 4ae0af84..01e87272 100644 --- a/src/uml/qumlmultiplicityelement.h +++ b/src/uml/qumlmultiplicityelement.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -94,7 +92,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlMultiplicityElement) *) -QT_END_HEADER - #endif // QUMLMULTIPLICITYELEMENT_H diff --git a/src/uml/qumlnamedelement.cpp b/src/uml/qumlnamedelement.cpp index 5f95c6e6..da134216 100644 --- a/src/uml/qumlnamedelement.cpp +++ b/src/uml/qumlnamedelement.cpp @@ -54,7 +54,13 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A named element supports using a string expression to specify its name. This allows names of model elements to involve template parameters. The actual name is evaluated from the string expression only when it is sensible to do so (e.g., when a template is bound).A named element is an element in a model that may have a name. + + \b {QUmlNamedElement is an abstract class.} */ + +/*! + Creates a new QUmlNamedElement. +*/ QUmlNamedElement::QUmlNamedElement() : _nameExpression(0), _namespace_(0), @@ -62,6 +68,9 @@ QUmlNamedElement::QUmlNamedElement() : { } +/*! + Returns a deep-copied clone of the QUmlNamedElement. +*/ QModelingElement *QUmlNamedElement::clone() const { QUmlNamedElement *c = new QUmlNamedElement; @@ -80,6 +89,12 @@ QModelingElement *QUmlNamedElement::clone() const /*! Indicates the dependencies that reference the client. + + \sa addClientDependency(), removeClientDependency() + + \b {Subsetted property(ies):} . + + \b {Opposite property(ies):} QUmlDependency::clients(). */ const QSet<QUmlDependency *> QUmlNamedElement::clientDependencies() const { @@ -88,6 +103,11 @@ const QSet<QUmlDependency *> QUmlNamedElement::clientDependencies() const return _clientDependencies; } +/*! + Adds \a clientDependency to clientDependencies. + + \sa clientDependencies(), removeClientDependency() + */ void QUmlNamedElement::addClientDependency(QUmlDependency *clientDependency) { // This is a read-write association end @@ -104,6 +124,11 @@ void QUmlNamedElement::addClientDependency(QUmlDependency *clientDependency) } } +/*! + Removes \a clientDependency from clientDependencies. + + \sa clientDependencies(), addClientDependency() + */ void QUmlNamedElement::removeClientDependency(QUmlDependency *clientDependency) { // This is a read-write association end @@ -128,6 +153,9 @@ QString QUmlNamedElement::name() const return _name; } +/*! + Adjusts name to \a name. + */ void QUmlNamedElement::setName(QString name) { // This is a read-write property @@ -140,6 +168,8 @@ void QUmlNamedElement::setName(QString name) /*! The string expression used to define the name of this named element. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlStringExpression *QUmlNamedElement::nameExpression() const { @@ -148,6 +178,9 @@ QUmlStringExpression *QUmlNamedElement::nameExpression() const return _nameExpression; } +/*! + Adjusts nameExpression to \a nameExpression. + */ void QUmlNamedElement::setNameExpression(QUmlStringExpression *nameExpression) { // This is a read-write association end @@ -170,6 +203,12 @@ void QUmlNamedElement::setNameExpression(QUmlStringExpression *nameExpression) /*! Specifies the namespace that owns the NamedElement. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlNamespace::ownedMembers(). */ QUmlNamespace *QUmlNamedElement::namespace_() const { @@ -178,6 +217,9 @@ QUmlNamespace *QUmlNamedElement::namespace_() const return _namespace_; } +/*! + Adjusts namespace_ to \a namespace_. + */ void QUmlNamedElement::setNamespace(QUmlNamespace *namespace_) { // This is a read-only derived union association end @@ -196,6 +238,8 @@ void QUmlNamedElement::setNamespace(QUmlNamespace *namespace_) /*! A name which allows the NamedElement to be identified within a hierarchy of nested Namespaces. It is constructed from the names of the containing namespaces starting at the root of the hierarchy and ending with the name of the NamedElement itself. + + \b {This is a read-only derived property.} */ QString QUmlNamedElement::qualifiedName() const { @@ -213,6 +257,9 @@ QString QUmlNamedElement::qualifiedName() const return qualifiedName_; } +/*! + Adjusts qualifiedName to \a qualifiedName. + */ void QUmlNamedElement::setQualifiedName(QString qualifiedName) { // This is a read-only derived property @@ -235,6 +282,9 @@ QtUml::VisibilityKind QUmlNamedElement::visibility() const return _visibility; } +/*! + Adjusts visibility to \a visibility. + */ void QUmlNamedElement::setVisibility(QtUml::VisibilityKind visibility) { // This is a read-write property diff --git a/src/uml/qumlnamedelement.h b/src/uml/qumlnamedelement.h index cb36e834..97b96506 100644 --- a/src/uml/qumlnamedelement.h +++ b/src/uml/qumlnamedelement.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -98,7 +96,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlNamedElement) *) -QT_END_HEADER - #endif // QUMLNAMEDELEMENT_H diff --git a/src/uml/qumlnamespace.cpp b/src/uml/qumlnamespace.cpp index 55891e7c..0691ea87 100644 --- a/src/uml/qumlnamespace.cpp +++ b/src/uml/qumlnamespace.cpp @@ -58,11 +58,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A namespace is an element in a model that contains a set of named elements that can be identified by name. + + \b {QUmlNamespace is an abstract class.} */ + +/*! + Creates a new QUmlNamespace. +*/ QUmlNamespace::QUmlNamespace() { } +/*! + Returns a deep-copied clone of the QUmlNamespace. +*/ QModelingElement *QUmlNamespace::clone() const { QUmlNamespace *c = new QUmlNamespace; @@ -87,6 +96,12 @@ QModelingElement *QUmlNamespace::clone() const /*! References the ElementImports owned by the Namespace. + + \sa addElementImport(), removeElementImport() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlElementImport::importingNamespace(). */ const QSet<QUmlElementImport *> QUmlNamespace::elementImports() const { @@ -95,6 +110,11 @@ const QSet<QUmlElementImport *> QUmlNamespace::elementImports() const return _elementImports; } +/*! + Adds \a elementImport to elementImports. + + \sa elementImports(), removeElementImport() + */ void QUmlNamespace::addElementImport(QUmlElementImport *elementImport) { // This is a read-write association end @@ -115,6 +135,11 @@ void QUmlNamespace::addElementImport(QUmlElementImport *elementImport) } } +/*! + Removes \a elementImport from elementImports. + + \sa elementImports(), addElementImport() + */ void QUmlNamespace::removeElementImport(QUmlElementImport *elementImport) { // This is a read-write association end @@ -136,6 +161,10 @@ void QUmlNamespace::removeElementImport(QUmlElementImport *elementImport) /*! References the PackageableElements that are members of this Namespace as a result of either PackageImports or ElementImports. + + \b {This is a read-only derived property.} + + \b {Subsetted property(ies):} QUmlNamespace::members(). */ const QSet<QUmlPackageableElement *> QUmlNamespace::importedMembers() const { @@ -150,6 +179,11 @@ const QSet<QUmlPackageableElement *> QUmlNamespace::importedMembers() const return importedMembers_; } +/*! + Adds \a importedMember to importedMembers. + + \sa importedMembers(), removeImportedMember() + */ void QUmlNamespace::addImportedMember(QUmlPackageableElement *importedMember) { // This is a read-only derived association end @@ -165,6 +199,11 @@ void QUmlNamespace::addImportedMember(QUmlPackageableElement *importedMember) } } +/*! + Removes \a importedMember from importedMembers. + + \sa importedMembers(), addImportedMember() + */ void QUmlNamespace::removeImportedMember(QUmlPackageableElement *importedMember) { // This is a read-only derived association end @@ -182,6 +221,8 @@ void QUmlNamespace::removeImportedMember(QUmlPackageableElement *importedMember) /*! A collection of NamedElements identifiable within the Namespace, either by being owned or by being introduced by importing or inheritance. + + \b {This is a read-only derived union property.} */ const QSet<QUmlNamedElement *> QUmlNamespace::members() const { @@ -190,6 +231,11 @@ const QSet<QUmlNamedElement *> QUmlNamespace::members() const return _members; } +/*! + Adds \a member to members. + + \sa members(), removeMember() + */ void QUmlNamespace::addMember(QUmlNamedElement *member) { // This is a read-only derived union association end @@ -201,6 +247,11 @@ void QUmlNamespace::addMember(QUmlNamedElement *member) } } +/*! + Removes \a member from members. + + \sa members(), addMember() + */ void QUmlNamespace::removeMember(QUmlNamedElement *member) { // This is a read-only derived union association end @@ -212,6 +263,12 @@ void QUmlNamespace::removeMember(QUmlNamedElement *member) /*! A collection of NamedElements owned by the Namespace. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} QUmlNamespace::members(), QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlNamedElement::namespace_(). */ const QSet<QUmlNamedElement *> QUmlNamespace::ownedMembers() const { @@ -220,6 +277,11 @@ const QSet<QUmlNamedElement *> QUmlNamespace::ownedMembers() const return _ownedMembers; } +/*! + Adds \a ownedMember to ownedMembers. + + \sa ownedMembers(), removeOwnedMember() + */ void QUmlNamespace::addOwnedMember(QUmlNamedElement *ownedMember) { // This is a read-only derived union association end @@ -241,6 +303,11 @@ void QUmlNamespace::addOwnedMember(QUmlNamedElement *ownedMember) } } +/*! + Removes \a ownedMember from ownedMembers. + + \sa ownedMembers(), addOwnedMember() + */ void QUmlNamespace::removeOwnedMember(QUmlNamedElement *ownedMember) { // This is a read-only derived union association end @@ -263,6 +330,12 @@ void QUmlNamespace::removeOwnedMember(QUmlNamedElement *ownedMember) /*! Specifies a set of Constraints owned by this Namespace. + + \sa addOwnedRule(), removeOwnedRule() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlConstraint::context(). */ const QSet<QUmlConstraint *> QUmlNamespace::ownedRules() const { @@ -271,6 +344,11 @@ const QSet<QUmlConstraint *> QUmlNamespace::ownedRules() const return _ownedRules; } +/*! + Adds \a ownedRule to ownedRules. + + \sa ownedRules(), removeOwnedRule() + */ void QUmlNamespace::addOwnedRule(QUmlConstraint *ownedRule) { // This is a read-write association end @@ -291,6 +369,11 @@ void QUmlNamespace::addOwnedRule(QUmlConstraint *ownedRule) } } +/*! + Removes \a ownedRule from ownedRules. + + \sa ownedRules(), addOwnedRule() + */ void QUmlNamespace::removeOwnedRule(QUmlConstraint *ownedRule) { // This is a read-write association end @@ -312,6 +395,12 @@ void QUmlNamespace::removeOwnedRule(QUmlConstraint *ownedRule) /*! References the PackageImports owned by the Namespace. + + \sa addPackageImport(), removePackageImport() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlPackageImport::importingNamespace(). */ const QSet<QUmlPackageImport *> QUmlNamespace::packageImports() const { @@ -320,6 +409,11 @@ const QSet<QUmlPackageImport *> QUmlNamespace::packageImports() const return _packageImports; } +/*! + Adds \a packageImport to packageImports. + + \sa packageImports(), removePackageImport() + */ void QUmlNamespace::addPackageImport(QUmlPackageImport *packageImport) { // This is a read-write association end @@ -340,6 +434,11 @@ void QUmlNamespace::addPackageImport(QUmlPackageImport *packageImport) } } +/*! + Removes \a packageImport from packageImports. + + \sa packageImports(), addPackageImport() + */ void QUmlNamespace::removePackageImport(QUmlPackageImport *packageImport) { // This is a read-write association end diff --git a/src/uml/qumlnamespace.h b/src/uml/qumlnamespace.h index 83ee641c..98849e4e 100644 --- a/src/uml/qumlnamespace.h +++ b/src/uml/qumlnamespace.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -101,7 +99,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlNamespace) *) -QT_END_HEADER - #endif // QUMLNAMESPACE_H diff --git a/src/uml/qumlnode.cpp b/src/uml/qumlnode.cpp index d468fb76..2ebe1762 100644 --- a/src/uml/qumlnode.cpp +++ b/src/uml/qumlnode.cpp @@ -88,6 +88,10 @@ QT_BEGIN_NAMESPACE \brief A node is computational resource upon which artifacts may be deployed for execution. Nodes can be interconnected through communication paths to define network structures. */ + +/*! + Creates a new QUmlNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlNode::QUmlNode(bool createQModelingObject) : QUmlClass(false) { @@ -95,6 +99,9 @@ QUmlNode::QUmlNode(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlNode. +*/ QModelingElement *QUmlNode::clone() const { QUmlNode *c = new QUmlNode; @@ -169,6 +176,10 @@ QModelingElement *QUmlNode::clone() const /*! The Nodes that are defined (nested) within the Node. + + \sa addNestedNode(), removeNestedNode() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QSet<QUmlNode *> QUmlNode::nestedNodes() const { @@ -177,6 +188,11 @@ const QSet<QUmlNode *> QUmlNode::nestedNodes() const return _nestedNodes; } +/*! + Adds \a nestedNode to nestedNodes. + + \sa nestedNodes(), removeNestedNode() + */ void QUmlNode::addNestedNode(QUmlNode *nestedNode) { // This is a read-write association end @@ -192,6 +208,11 @@ void QUmlNode::addNestedNode(QUmlNode *nestedNode) } } +/*! + Removes \a nestedNode from nestedNodes. + + \sa nestedNodes(), addNestedNode() + */ void QUmlNode::removeNestedNode(QUmlNode *nestedNode) { // This is a read-write association end diff --git a/src/uml/qumlnode.h b/src/uml/qumlnode.h index 94fb4888..68be88c4 100644 --- a/src/uml/qumlnode.h +++ b/src/uml/qumlnode.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlClass> #include <QtUml/QUmlDeploymentTarget> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlNode) *) -QT_END_HEADER - #endif // QUMLNODE_H diff --git a/src/uml/qumlobjectflow.cpp b/src/uml/qumlobjectflow.cpp index 11252113..ad12bbf7 100644 --- a/src/uml/qumlobjectflow.cpp +++ b/src/uml/qumlobjectflow.cpp @@ -69,6 +69,10 @@ QT_BEGIN_NAMESPACE \brief An object flow is an activity edge that can have objects or data passing along it.Object flows have support for multicast/receive, token selection from object nodes, and transformation of tokens. */ + +/*! + Creates a new QUmlObjectFlow. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlObjectFlow::QUmlObjectFlow(bool createQModelingObject) : _isMulticast(false), _isMultireceive(false), @@ -79,6 +83,9 @@ QUmlObjectFlow::QUmlObjectFlow(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlObjectFlowObject(this)); } +/*! + Returns a deep-copied clone of the QUmlObjectFlow. +*/ QModelingElement *QUmlObjectFlow::clone() const { QUmlObjectFlow *c = new QUmlObjectFlow; @@ -130,6 +137,9 @@ bool QUmlObjectFlow::isMulticast() const return _isMulticast; } +/*! + Adjusts isMulticast to \a isMulticast. + */ void QUmlObjectFlow::setMulticast(bool isMulticast) { // This is a read-write property @@ -150,6 +160,9 @@ bool QUmlObjectFlow::isMultireceive() const return _isMultireceive; } +/*! + Adjusts isMultireceive to \a isMultireceive. + */ void QUmlObjectFlow::setMultireceive(bool isMultireceive) { // This is a read-write property @@ -170,6 +183,9 @@ QUmlBehavior *QUmlObjectFlow::selection() const return _selection; } +/*! + Adjusts selection to \a selection. + */ void QUmlObjectFlow::setSelection(QUmlBehavior *selection) { // This is a read-write association end @@ -191,6 +207,9 @@ QUmlBehavior *QUmlObjectFlow::transformation() const return _transformation; } +/*! + Adjusts transformation to \a transformation. + */ void QUmlObjectFlow::setTransformation(QUmlBehavior *transformation) { // This is a read-write association end diff --git a/src/uml/qumlobjectflow.h b/src/uml/qumlobjectflow.h index 05c0e347..f0bfb0e8 100644 --- a/src/uml/qumlobjectflow.h +++ b/src/uml/qumlobjectflow.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlActivityEdge> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlObjectFlow) *) -QT_END_HEADER - #endif // QUMLOBJECTFLOW_H diff --git a/src/uml/qumlobjectnode.cpp b/src/uml/qumlobjectnode.cpp index 5c86710f..05dc2364 100644 --- a/src/uml/qumlobjectnode.cpp +++ b/src/uml/qumlobjectnode.cpp @@ -68,7 +68,13 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief An object node is an abstract activity node that is part of defining object flow in an activity.Object nodes have support for token selection, limitation on the number of tokens, specifying the state required for tokens, and carrying control values. + + \b {QUmlObjectNode is an abstract class.} */ + +/*! + Creates a new QUmlObjectNode. +*/ QUmlObjectNode::QUmlObjectNode() : _isControlType(false), _ordering(QtUml::ObjectNodeOrderingKindFIFO), @@ -77,6 +83,9 @@ QUmlObjectNode::QUmlObjectNode() : { } +/*! + Returns a deep-copied clone of the QUmlObjectNode. +*/ QModelingElement *QUmlObjectNode::clone() const { QUmlObjectNode *c = new QUmlObjectNode; @@ -120,6 +129,8 @@ QModelingElement *QUmlObjectNode::clone() const /*! The required states of the object available at this point in the activity. + + \sa addInState(), removeInState() */ const QSet<QUmlState *> QUmlObjectNode::inStates() const { @@ -128,6 +139,11 @@ const QSet<QUmlState *> QUmlObjectNode::inStates() const return _inStates; } +/*! + Adds \a inState to inStates. + + \sa inStates(), removeInState() + */ void QUmlObjectNode::addInState(QUmlState *inState) { // This is a read-write association end @@ -139,6 +155,11 @@ void QUmlObjectNode::addInState(QUmlState *inState) } } +/*! + Removes \a inState from inStates. + + \sa inStates(), addInState() + */ void QUmlObjectNode::removeInState(QUmlState *inState) { // This is a read-write association end @@ -158,6 +179,9 @@ bool QUmlObjectNode::isControlType() const return _isControlType; } +/*! + Adjusts isControlType to \a isControlType. + */ void QUmlObjectNode::setControlType(bool isControlType) { // This is a read-write property @@ -178,6 +202,9 @@ QtUml::ObjectNodeOrderingKind QUmlObjectNode::ordering() const return _ordering; } +/*! + Adjusts ordering to \a ordering. + */ void QUmlObjectNode::setOrdering(QtUml::ObjectNodeOrderingKind ordering) { // This is a read-write property @@ -198,6 +225,9 @@ QUmlBehavior *QUmlObjectNode::selection() const return _selection; } +/*! + Adjusts selection to \a selection. + */ void QUmlObjectNode::setSelection(QUmlBehavior *selection) { // This is a read-write association end @@ -211,6 +241,8 @@ void QUmlObjectNode::setSelection(QUmlBehavior *selection) /*! The maximum number of tokens allowed in the node. Objects cannot flow into the node if the upper bound is reached. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlObjectNode::upperBound() const { @@ -219,6 +251,9 @@ QUmlValueSpecification *QUmlObjectNode::upperBound() const return _upperBound; } +/*! + Adjusts upperBound to \a upperBound. + */ void QUmlObjectNode::setUpperBound(QUmlValueSpecification *upperBound) { // This is a read-write association end diff --git a/src/uml/qumlobjectnode.h b/src/uml/qumlobjectnode.h index 8f611594..0acccd0c 100644 --- a/src/uml/qumlobjectnode.h +++ b/src/uml/qumlobjectnode.h @@ -48,8 +48,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -90,7 +88,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlObjectNode) *) -QT_END_HEADER - #endif // QUMLOBJECTNODE_H diff --git a/src/uml/qumlobservation.cpp b/src/uml/qumlobservation.cpp index 0a873f81..986d4ea9 100644 --- a/src/uml/qumlobservation.cpp +++ b/src/uml/qumlobservation.cpp @@ -58,11 +58,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief Observation is a superclass of TimeObservation and DurationObservation in order for TimeExpression and Duration to refer to either in a simple way. + + \b {QUmlObservation is an abstract class.} */ + +/*! + Creates a new QUmlObservation. +*/ QUmlObservation::QUmlObservation() { } +/*! + Returns a deep-copied clone of the QUmlObservation. +*/ QModelingElement *QUmlObservation::clone() const { QUmlObservation *c = new QUmlObservation; diff --git a/src/uml/qumlobservation.h b/src/uml/qumlobservation.h index e15a468f..41ee9494 100644 --- a/src/uml/qumlobservation.h +++ b/src/uml/qumlobservation.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlPackageableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlObservation) *) -QT_END_HEADER - #endif // QUMLOBSERVATION_H diff --git a/src/uml/qumloccurrencespecification.cpp b/src/uml/qumloccurrencespecification.cpp index 5f24c01f..cf18dc04 100644 --- a/src/uml/qumloccurrencespecification.cpp +++ b/src/uml/qumloccurrencespecification.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief An occurrence specification is the basic semantic unit of interactions. The sequences of occurrences specified by them are the meanings of interactions. */ + +/*! + Creates a new QUmlOccurrenceSpecification. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlOccurrenceSpecification::QUmlOccurrenceSpecification(bool createQModelingObject) : _covered(0) { @@ -70,6 +74,9 @@ QUmlOccurrenceSpecification::QUmlOccurrenceSpecification(bool createQModelingObj _qModelingObject = qobject_cast<QModelingObject *>(new QUmlOccurrenceSpecificationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlOccurrenceSpecification. +*/ QModelingElement *QUmlOccurrenceSpecification::clone() const { QUmlOccurrenceSpecification *c = new QUmlOccurrenceSpecification; @@ -100,6 +107,8 @@ QModelingElement *QUmlOccurrenceSpecification::clone() const /*! References the Lifeline on which the OccurrenceSpecification appears. + + \b {Redefined property(ies):} QUmlInteractionFragment::covered(). */ QUmlLifeline *QUmlOccurrenceSpecification::covered() const { @@ -108,6 +117,9 @@ QUmlLifeline *QUmlOccurrenceSpecification::covered() const return _covered; } +/*! + Adjusts covered to \a covered. + */ void QUmlOccurrenceSpecification::setCovered(QUmlLifeline *covered) { // This is a read-write association end @@ -128,6 +140,10 @@ void QUmlOccurrenceSpecification::setCovered(QUmlLifeline *covered) /*! References the GeneralOrderings that specify EventOcurrences that must occur after this OccurrenceSpecification + + \sa addToAfter(), removeToAfter() + + \b {Opposite property(ies):} QUmlGeneralOrdering::before(). */ const QSet<QUmlGeneralOrdering *> QUmlOccurrenceSpecification::toAfters() const { @@ -136,6 +152,11 @@ const QSet<QUmlGeneralOrdering *> QUmlOccurrenceSpecification::toAfters() const return _toAfters; } +/*! + Adds \a toAfter to toAfters. + + \sa toAfters(), removeToAfter() + */ void QUmlOccurrenceSpecification::addToAfter(QUmlGeneralOrdering *toAfter) { // This is a read-write association end @@ -152,6 +173,11 @@ void QUmlOccurrenceSpecification::addToAfter(QUmlGeneralOrdering *toAfter) } } +/*! + Removes \a toAfter from toAfters. + + \sa toAfters(), addToAfter() + */ void QUmlOccurrenceSpecification::removeToAfter(QUmlGeneralOrdering *toAfter) { // This is a read-write association end @@ -168,6 +194,10 @@ void QUmlOccurrenceSpecification::removeToAfter(QUmlGeneralOrdering *toAfter) /*! References the GeneralOrderings that specify EventOcurrences that must occur before this OccurrenceSpecification + + \sa addToBefore(), removeToBefore() + + \b {Opposite property(ies):} QUmlGeneralOrdering::after(). */ const QSet<QUmlGeneralOrdering *> QUmlOccurrenceSpecification::toBefores() const { @@ -176,6 +206,11 @@ const QSet<QUmlGeneralOrdering *> QUmlOccurrenceSpecification::toBefores() const return _toBefores; } +/*! + Adds \a toBefore to toBefores. + + \sa toBefores(), removeToBefore() + */ void QUmlOccurrenceSpecification::addToBefore(QUmlGeneralOrdering *toBefore) { // This is a read-write association end @@ -192,6 +227,11 @@ void QUmlOccurrenceSpecification::addToBefore(QUmlGeneralOrdering *toBefore) } } +/*! + Removes \a toBefore from toBefores. + + \sa toBefores(), addToBefore() + */ void QUmlOccurrenceSpecification::removeToBefore(QUmlGeneralOrdering *toBefore) { // This is a read-write association end diff --git a/src/uml/qumloccurrencespecification.h b/src/uml/qumloccurrencespecification.h index 93637ba4..5dfce7a9 100644 --- a/src/uml/qumloccurrencespecification.h +++ b/src/uml/qumloccurrencespecification.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInteractionFragment> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlOccurrenceSpecification) *) -QT_END_HEADER - #endif // QUMLOCCURRENCESPECIFICATION_H diff --git a/src/uml/qumlopaqueaction.cpp b/src/uml/qumlopaqueaction.cpp index cb4e7970..34e6fcdb 100644 --- a/src/uml/qumlopaqueaction.cpp +++ b/src/uml/qumlopaqueaction.cpp @@ -72,12 +72,19 @@ QT_BEGIN_NAMESPACE \brief An action with implementation-specific semantics. */ + +/*! + Creates a new QUmlOpaqueAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlOpaqueAction::QUmlOpaqueAction(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlOpaqueActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlOpaqueAction. +*/ QModelingElement *QUmlOpaqueAction::clone() const { QUmlOpaqueAction *c = new QUmlOpaqueAction; @@ -126,6 +133,8 @@ QModelingElement *QUmlOpaqueAction::clone() const /*! Specifies the action in one or more languages. + + \sa addBody(), removeBody() */ const QList<QString> QUmlOpaqueAction::bodies() const { @@ -134,6 +143,11 @@ const QList<QString> QUmlOpaqueAction::bodies() const return _bodies; } +/*! + Adds \a body to bodies. + + \sa bodies(), removeBody() + */ void QUmlOpaqueAction::addBody(QString body) { // This is a read-write property @@ -143,6 +157,11 @@ void QUmlOpaqueAction::addBody(QString body) } } +/*! + Removes \a body from bodies. + + \sa bodies(), addBody() + */ void QUmlOpaqueAction::removeBody(QString body) { // This is a read-write property @@ -154,6 +173,10 @@ void QUmlOpaqueAction::removeBody(QString body) /*! Provides input to the action. + + \sa addInputValue(), removeInputValue() + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ const QSet<QUmlInputPin *> QUmlOpaqueAction::inputValues() const { @@ -162,6 +185,11 @@ const QSet<QUmlInputPin *> QUmlOpaqueAction::inputValues() const return _inputValues; } +/*! + Adds \a inputValue to inputValues. + + \sa inputValues(), removeInputValue() + */ void QUmlOpaqueAction::addInputValue(QUmlInputPin *inputValue) { // This is a read-write association end @@ -177,6 +205,11 @@ void QUmlOpaqueAction::addInputValue(QUmlInputPin *inputValue) } } +/*! + Removes \a inputValue from inputValues. + + \sa inputValues(), addInputValue() + */ void QUmlOpaqueAction::removeInputValue(QUmlInputPin *inputValue) { // This is a read-write association end @@ -193,6 +226,8 @@ void QUmlOpaqueAction::removeInputValue(QUmlInputPin *inputValue) /*! Languages the body strings use, in the same order as the body strings + + \sa addLanguage(), removeLanguage() */ const QList<QString> QUmlOpaqueAction::languages() const { @@ -201,6 +236,11 @@ const QList<QString> QUmlOpaqueAction::languages() const return _languages; } +/*! + Adds \a language to languages. + + \sa languages(), removeLanguage() + */ void QUmlOpaqueAction::addLanguage(QString language) { // This is a read-write property @@ -210,6 +250,11 @@ void QUmlOpaqueAction::addLanguage(QString language) } } +/*! + Removes \a language from languages. + + \sa languages(), addLanguage() + */ void QUmlOpaqueAction::removeLanguage(QString language) { // This is a read-write property @@ -221,6 +266,10 @@ void QUmlOpaqueAction::removeLanguage(QString language) /*! Takes output from the action. + + \sa addOutputValue(), removeOutputValue() + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ const QSet<QUmlOutputPin *> QUmlOpaqueAction::outputValues() const { @@ -229,6 +278,11 @@ const QSet<QUmlOutputPin *> QUmlOpaqueAction::outputValues() const return _outputValues; } +/*! + Adds \a outputValue to outputValues. + + \sa outputValues(), removeOutputValue() + */ void QUmlOpaqueAction::addOutputValue(QUmlOutputPin *outputValue) { // This is a read-write association end @@ -244,6 +298,11 @@ void QUmlOpaqueAction::addOutputValue(QUmlOutputPin *outputValue) } } +/*! + Removes \a outputValue from outputValues. + + \sa outputValues(), addOutputValue() + */ void QUmlOpaqueAction::removeOutputValue(QUmlOutputPin *outputValue) { // This is a read-write association end diff --git a/src/uml/qumlopaqueaction.h b/src/uml/qumlopaqueaction.h index 533489da..32d36df2 100644 --- a/src/uml/qumlopaqueaction.h +++ b/src/uml/qumlopaqueaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -86,7 +84,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlOpaqueAction) *) -QT_END_HEADER - #endif // QUMLOPAQUEACTION_H diff --git a/src/uml/qumlopaquebehavior.cpp b/src/uml/qumlopaquebehavior.cpp index 08bd041f..2c3bda26 100644 --- a/src/uml/qumlopaquebehavior.cpp +++ b/src/uml/qumlopaquebehavior.cpp @@ -91,12 +91,19 @@ QT_BEGIN_NAMESPACE \brief An behavior with implementation-specific semantics. */ + +/*! + Creates a new QUmlOpaqueBehavior. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlOpaqueBehavior::QUmlOpaqueBehavior(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlOpaqueBehaviorObject(this)); } +/*! + Returns a deep-copied clone of the QUmlOpaqueBehavior. +*/ QModelingElement *QUmlOpaqueBehavior::clone() const { QUmlOpaqueBehavior *c = new QUmlOpaqueBehavior; @@ -184,6 +191,8 @@ QModelingElement *QUmlOpaqueBehavior::clone() const /*! Specifies the behavior in one or more languages. + + \sa addBody(), removeBody() */ const QList<QString> QUmlOpaqueBehavior::bodies() const { @@ -192,6 +201,11 @@ const QList<QString> QUmlOpaqueBehavior::bodies() const return _bodies; } +/*! + Adds \a body to bodies. + + \sa bodies(), removeBody() + */ void QUmlOpaqueBehavior::addBody(QString body) { // This is a read-write property @@ -201,6 +215,11 @@ void QUmlOpaqueBehavior::addBody(QString body) } } +/*! + Removes \a body from bodies. + + \sa bodies(), addBody() + */ void QUmlOpaqueBehavior::removeBody(QString body) { // This is a read-write property @@ -212,6 +231,8 @@ void QUmlOpaqueBehavior::removeBody(QString body) /*! Languages the body strings use in the same order as the body strings. + + \sa addLanguage(), removeLanguage() */ const QList<QString> QUmlOpaqueBehavior::languages() const { @@ -220,6 +241,11 @@ const QList<QString> QUmlOpaqueBehavior::languages() const return _languages; } +/*! + Adds \a language to languages. + + \sa languages(), removeLanguage() + */ void QUmlOpaqueBehavior::addLanguage(QString language) { // This is a read-write property @@ -229,6 +255,11 @@ void QUmlOpaqueBehavior::addLanguage(QString language) } } +/*! + Removes \a language from languages. + + \sa languages(), addLanguage() + */ void QUmlOpaqueBehavior::removeLanguage(QString language) { // This is a read-write property diff --git a/src/uml/qumlopaquebehavior.h b/src/uml/qumlopaquebehavior.h index 16e4bb80..af911853 100644 --- a/src/uml/qumlopaquebehavior.h +++ b/src/uml/qumlopaquebehavior.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlBehavior> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlOpaqueBehavior) *) -QT_END_HEADER - #endif // QUMLOPAQUEBEHAVIOR_H diff --git a/src/uml/qumlopaqueexpression.cpp b/src/uml/qumlopaqueexpression.cpp index 464f03a9..03cb0acd 100644 --- a/src/uml/qumlopaqueexpression.cpp +++ b/src/uml/qumlopaqueexpression.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief An opaque expression is an uninterpreted textual statement that denotes a (possibly empty) set of values when evaluated in a context.Provides a mechanism for precisely defining the behavior of an opaque expression. An opaque expression is defined by a behavior restricted to return one result. */ + +/*! + Creates a new QUmlOpaqueExpression. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlOpaqueExpression::QUmlOpaqueExpression(bool createQModelingObject) : _behavior(0) { @@ -71,6 +75,9 @@ QUmlOpaqueExpression::QUmlOpaqueExpression(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlOpaqueExpressionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlOpaqueExpression. +*/ QModelingElement *QUmlOpaqueExpression::clone() const { QUmlOpaqueExpression *c = new QUmlOpaqueExpression; @@ -109,6 +116,9 @@ QUmlBehavior *QUmlOpaqueExpression::behavior() const return _behavior; } +/*! + Adjusts behavior to \a behavior. + */ void QUmlOpaqueExpression::setBehavior(QUmlBehavior *behavior) { // This is a read-write association end @@ -122,6 +132,8 @@ void QUmlOpaqueExpression::setBehavior(QUmlBehavior *behavior) /*! The text of the expression, possibly in multiple languages. + + \sa addBody(), removeBody() */ const QList<QString> QUmlOpaqueExpression::bodies() const { @@ -130,6 +142,11 @@ const QList<QString> QUmlOpaqueExpression::bodies() const return _bodies; } +/*! + Adds \a body to bodies. + + \sa bodies(), removeBody() + */ void QUmlOpaqueExpression::addBody(QString body) { // This is a read-write property @@ -139,6 +156,11 @@ void QUmlOpaqueExpression::addBody(QString body) } } +/*! + Removes \a body from bodies. + + \sa bodies(), addBody() + */ void QUmlOpaqueExpression::removeBody(QString body) { // This is a read-write property @@ -150,6 +172,8 @@ void QUmlOpaqueExpression::removeBody(QString body) /*! Specifies the languages in which the expression is stated. The interpretation of the expression body depends on the languages. If the languages are unspecified, they might be implicit from the expression body or the context. Languages are matched to body strings by order. + + \sa addLanguage(), removeLanguage() */ const QList<QString> QUmlOpaqueExpression::languages() const { @@ -158,6 +182,11 @@ const QList<QString> QUmlOpaqueExpression::languages() const return _languages; } +/*! + Adds \a language to languages. + + \sa languages(), removeLanguage() + */ void QUmlOpaqueExpression::addLanguage(QString language) { // This is a read-write property @@ -167,6 +196,11 @@ void QUmlOpaqueExpression::addLanguage(QString language) } } +/*! + Removes \a language from languages. + + \sa languages(), addLanguage() + */ void QUmlOpaqueExpression::removeLanguage(QString language) { // This is a read-write property @@ -178,6 +212,8 @@ void QUmlOpaqueExpression::removeLanguage(QString language) /*! Restricts an opaque expression to return exactly one return result. When the invocation of the opaque expression completes, a single set of values is returned to its owner. This association is derived from the single return result parameter of the associated behavior. + + \b {This is a read-only derived property.} */ QUmlParameter *QUmlOpaqueExpression::result() const { @@ -188,6 +224,9 @@ QUmlParameter *QUmlOpaqueExpression::result() const return 0; } +/*! + Adjusts result to \a result. + */ void QUmlOpaqueExpression::setResult(QUmlParameter *result) { // This is a read-only derived association end diff --git a/src/uml/qumlopaqueexpression.h b/src/uml/qumlopaqueexpression.h index c6b28155..d352c838 100644 --- a/src/uml/qumlopaqueexpression.h +++ b/src/uml/qumlopaqueexpression.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlValueSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -89,7 +87,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlOpaqueExpression) *) -QT_END_HEADER - #endif // QUMLOPAQUEEXPRESSION_H diff --git a/src/uml/qumloperation.cpp b/src/uml/qumloperation.cpp index 6dee7465..d8378f79 100644 --- a/src/uml/qumloperation.cpp +++ b/src/uml/qumloperation.cpp @@ -76,6 +76,10 @@ QT_BEGIN_NAMESPACE \brief An operation is a behavioral feature of a classifier that specifies the name, type, parameters, and constraints for invoking an associated behavior.An operation may invoke both the execution of method behaviors as well as other behavioral responses.Operation specializes TemplateableElement in order to support specification of template operations and bound operations. Operation specializes ParameterableElement to specify that an operation can be exposed as a formal template parameter, and provided as an actual parameter in a binding of a template. */ + +/*! + Creates a new QUmlOperation. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlOperation::QUmlOperation(bool createQModelingObject) : _bodyCondition(0), _class_(0), @@ -88,6 +92,9 @@ QUmlOperation::QUmlOperation(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlOperationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlOperation. +*/ QModelingElement *QUmlOperation::clone() const { QUmlOperation *c = new QUmlOperation; @@ -147,6 +154,8 @@ QModelingElement *QUmlOperation::clone() const /*! An optional Constraint on the result values of an invocation of this Operation. + + \b {Subsetted property(ies):} QUmlNamespace::ownedRules(). */ QUmlConstraint *QUmlOperation::bodyCondition() const { @@ -155,6 +164,9 @@ QUmlConstraint *QUmlOperation::bodyCondition() const return _bodyCondition; } +/*! + Adjusts bodyCondition to \a bodyCondition. + */ void QUmlOperation::setBodyCondition(QUmlConstraint *bodyCondition) { // This is a read-write association end @@ -177,6 +189,10 @@ void QUmlOperation::setBodyCondition(QUmlConstraint *bodyCondition) /*! The class that owns the operation. + + \b {Subsetted property(ies):} QUmlFeature::featuringClassifiers(), QUmlRedefinableElement::redefinitionContexts(), QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlClass::ownedOperations(). */ QUmlClass *QUmlOperation::class_() const { @@ -185,6 +201,9 @@ QUmlClass *QUmlOperation::class_() const return _class_; } +/*! + Adjusts class_ to \a class_. + */ void QUmlOperation::setClass(QUmlClass *class_) { // This is a read-write association end @@ -211,6 +230,10 @@ void QUmlOperation::setClass(QUmlClass *class_) /*! The DataType that owns this Operation. + + \b {Subsetted property(ies):} QUmlFeature::featuringClassifiers(), QUmlRedefinableElement::redefinitionContexts(), QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlDataType::ownedOperations(). */ QUmlDataType *QUmlOperation::datatype() const { @@ -219,6 +242,9 @@ QUmlDataType *QUmlOperation::datatype() const return _datatype; } +/*! + Adjusts datatype to \a datatype. + */ void QUmlOperation::setDatatype(QUmlDataType *datatype) { // This is a read-write association end @@ -245,6 +271,10 @@ void QUmlOperation::setDatatype(QUmlDataType *datatype) /*! The Interface that owns this Operation. + + \b {Subsetted property(ies):} QUmlFeature::featuringClassifiers(), QUmlRedefinableElement::redefinitionContexts(), QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlInterface::ownedOperations(). */ QUmlInterface *QUmlOperation::interface_() const { @@ -253,6 +283,9 @@ QUmlInterface *QUmlOperation::interface_() const return _interface_; } +/*! + Adjusts interface_ to \a interface_. + */ void QUmlOperation::setInterface(QUmlInterface *interface_) { // This is a read-write association end @@ -279,6 +312,8 @@ void QUmlOperation::setInterface(QUmlInterface *interface_) /*! This information is derived from the return result for this Operation.Specifies whether the return parameter is ordered or not, if present. + + \b {This is a read-only derived property.} */ bool QUmlOperation::isOrdered() const { @@ -289,6 +324,9 @@ bool QUmlOperation::isOrdered() const return bool(); } +/*! + Adjusts isOrdered to \a isOrdered. + */ void QUmlOperation::setOrdered(bool isOrdered) { // This is a read-only derived property @@ -311,6 +349,9 @@ bool QUmlOperation::isQuery() const return _isQuery; } +/*! + Adjusts isQuery to \a isQuery. + */ void QUmlOperation::setQuery(bool isQuery) { // This is a read-write property @@ -323,6 +364,8 @@ void QUmlOperation::setQuery(bool isQuery) /*! Specifies whether the return parameter is unique or not, if present.This information is derived from the return result for this Operation. + + \b {This is a read-only derived property.} */ bool QUmlOperation::isUnique() const { @@ -333,6 +376,9 @@ bool QUmlOperation::isUnique() const return bool(); } +/*! + Adjusts isUnique to \a isUnique. + */ void QUmlOperation::setUnique(bool isUnique) { // This is a read-only derived property @@ -347,6 +393,8 @@ void QUmlOperation::setUnique(bool isUnique) /*! This information is derived from the return result for this Operation.Specifies the lower multiplicity of the return parameter, if present. + + \b {This is a read-only derived property.} */ int QUmlOperation::lower() const { @@ -357,6 +405,9 @@ int QUmlOperation::lower() const return int(); } +/*! + Adjusts lower to \a lower. + */ void QUmlOperation::setLower(int lower) { // This is a read-only derived property @@ -371,6 +422,12 @@ void QUmlOperation::setLower(int lower) /*! Specifies the ordered set of formal parameters of this BehavioralFeature.Specifies the parameters owned by this Operation. + + \sa addOwnedParameter(), removeOwnedParameter() + + \b {Redefined property(ies):} QUmlBehavioralFeature::ownedParameters(). + + \b {Opposite property(ies):} QUmlParameter::operation(). */ const QList<QUmlParameter *> QUmlOperation::ownedParameters() const { @@ -379,6 +436,11 @@ const QList<QUmlParameter *> QUmlOperation::ownedParameters() const return _ownedParameters; } +/*! + Adds \a ownedParameter to ownedParameters. + + \sa ownedParameters(), removeOwnedParameter() + */ void QUmlOperation::addOwnedParameter(QUmlParameter *ownedParameter) { // This is a read-write association end @@ -399,6 +461,11 @@ void QUmlOperation::addOwnedParameter(QUmlParameter *ownedParameter) } } +/*! + Removes \a ownedParameter from ownedParameters. + + \sa ownedParameters(), addOwnedParameter() + */ void QUmlOperation::removeOwnedParameter(QUmlParameter *ownedParameter) { // This is a read-write association end @@ -420,6 +487,10 @@ void QUmlOperation::removeOwnedParameter(QUmlParameter *ownedParameter) /*! An optional set of Constraints specifying the state of the system when the Operation is completed. + + \sa addPostcondition(), removePostcondition() + + \b {Subsetted property(ies):} QUmlNamespace::ownedRules(). */ const QSet<QUmlConstraint *> QUmlOperation::postconditions() const { @@ -428,6 +499,11 @@ const QSet<QUmlConstraint *> QUmlOperation::postconditions() const return _postconditions; } +/*! + Adds \a postcondition to postconditions. + + \sa postconditions(), removePostcondition() + */ void QUmlOperation::addPostcondition(QUmlConstraint *postcondition) { // This is a read-write association end @@ -443,6 +519,11 @@ void QUmlOperation::addPostcondition(QUmlConstraint *postcondition) } } +/*! + Removes \a postcondition from postconditions. + + \sa postconditions(), addPostcondition() + */ void QUmlOperation::removePostcondition(QUmlConstraint *postcondition) { // This is a read-write association end @@ -459,6 +540,10 @@ void QUmlOperation::removePostcondition(QUmlConstraint *postcondition) /*! An optional set of Constraints on the state of the system when the Operation is invoked. + + \sa addPrecondition(), removePrecondition() + + \b {Subsetted property(ies):} QUmlNamespace::ownedRules(). */ const QSet<QUmlConstraint *> QUmlOperation::preconditions() const { @@ -467,6 +552,11 @@ const QSet<QUmlConstraint *> QUmlOperation::preconditions() const return _preconditions; } +/*! + Adds \a precondition to preconditions. + + \sa preconditions(), removePrecondition() + */ void QUmlOperation::addPrecondition(QUmlConstraint *precondition) { // This is a read-write association end @@ -482,6 +572,11 @@ void QUmlOperation::addPrecondition(QUmlConstraint *precondition) } } +/*! + Removes \a precondition from preconditions. + + \sa preconditions(), addPrecondition() + */ void QUmlOperation::removePrecondition(QUmlConstraint *precondition) { // This is a read-write association end @@ -498,6 +593,10 @@ void QUmlOperation::removePrecondition(QUmlConstraint *precondition) /*! References the Types representing exceptions that may be raised during an invocation of this operation. + + \sa addRaisedException(), removeRaisedException() + + \b {Redefined property(ies):} QUmlBehavioralFeature::raisedExceptions(). */ const QSet<QUmlType *> QUmlOperation::raisedExceptions() const { @@ -506,6 +605,11 @@ const QSet<QUmlType *> QUmlOperation::raisedExceptions() const return _raisedExceptions; } +/*! + Adds \a raisedException to raisedExceptions. + + \sa raisedExceptions(), removeRaisedException() + */ void QUmlOperation::addRaisedException(QUmlType *raisedException) { // This is a read-write association end @@ -520,6 +624,11 @@ void QUmlOperation::addRaisedException(QUmlType *raisedException) } } +/*! + Removes \a raisedException from raisedExceptions. + + \sa raisedExceptions(), addRaisedException() + */ void QUmlOperation::removeRaisedException(QUmlType *raisedException) { // This is a read-write association end @@ -534,6 +643,10 @@ void QUmlOperation::removeRaisedException(QUmlType *raisedException) /*! References the Operations that are redefined by this Operation. + + \sa addRedefinedOperation(), removeRedefinedOperation() + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinedElements(). */ const QSet<QUmlOperation *> QUmlOperation::redefinedOperations() const { @@ -542,6 +655,11 @@ const QSet<QUmlOperation *> QUmlOperation::redefinedOperations() const return _redefinedOperations; } +/*! + Adds \a redefinedOperation to redefinedOperations. + + \sa redefinedOperations(), removeRedefinedOperation() + */ void QUmlOperation::addRedefinedOperation(QUmlOperation *redefinedOperation) { // This is a read-write association end @@ -556,6 +674,11 @@ void QUmlOperation::addRedefinedOperation(QUmlOperation *redefinedOperation) } } +/*! + Removes \a redefinedOperation from redefinedOperations. + + \sa redefinedOperations(), addRedefinedOperation() + */ void QUmlOperation::removeRedefinedOperation(QUmlOperation *redefinedOperation) { // This is a read-write association end @@ -570,6 +693,10 @@ void QUmlOperation::removeRedefinedOperation(QUmlOperation *redefinedOperation) /*! The template parameter that exposes this element as a formal parameter. + + \b {Redefined property(ies):} QUmlParameterableElement::templateParameter(). + + \b {Opposite property(ies):} QUmlOperationTemplateParameter::parameteredElement(). */ QUmlOperationTemplateParameter *QUmlOperation::templateParameter() const { @@ -578,6 +705,9 @@ QUmlOperationTemplateParameter *QUmlOperation::templateParameter() const return _templateParameter; } +/*! + Adjusts templateParameter to \a templateParameter. + */ void QUmlOperation::setTemplateParameter(QUmlOperationTemplateParameter *templateParameter) { // This is a read-write association end @@ -594,6 +724,8 @@ void QUmlOperation::setTemplateParameter(QUmlOperationTemplateParameter *templat /*! This information is derived from the return result for this Operation.Specifies the return result of the operation, if present. + + \b {This is a read-only derived property.} */ QUmlType *QUmlOperation::type() const { @@ -604,6 +736,9 @@ QUmlType *QUmlOperation::type() const return 0; } +/*! + Adjusts type to \a type. + */ void QUmlOperation::setType(QUmlType *type) { // This is a read-only derived association end @@ -618,6 +753,8 @@ void QUmlOperation::setType(QUmlType *type) /*! This information is derived from the return result for this Operation.Specifies the upper multiplicity of the return parameter, if present. + + \b {This is a read-only derived property.} */ QString QUmlOperation::upper() const { @@ -628,6 +765,9 @@ QString QUmlOperation::upper() const return QString(); } +/*! + Adjusts upper to \a upper. + */ void QUmlOperation::setUpper(QString upper) { // This is a read-only derived property diff --git a/src/uml/qumloperation.h b/src/uml/qumloperation.h index d4f8f532..73a650f3 100644 --- a/src/uml/qumloperation.h +++ b/src/uml/qumloperation.h @@ -47,8 +47,6 @@ #include <QtUml/QUmlBehavioralFeature> #include <QtUml/QUmlParameterableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -130,7 +128,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlOperation) *) -QT_END_HEADER - #endif // QUMLOPERATION_H diff --git a/src/uml/qumloperationtemplateparameter.cpp b/src/uml/qumloperationtemplateparameter.cpp index aadb4eb5..be83561f 100644 --- a/src/uml/qumloperationtemplateparameter.cpp +++ b/src/uml/qumloperationtemplateparameter.cpp @@ -57,6 +57,10 @@ QT_BEGIN_NAMESPACE \brief An operation template parameter exposes an operation as a formal parameter for a template. */ + +/*! + Creates a new QUmlOperationTemplateParameter. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlOperationTemplateParameter::QUmlOperationTemplateParameter(bool createQModelingObject) : QUmlTemplateParameter(false), _parameteredElement(0) @@ -65,6 +69,9 @@ QUmlOperationTemplateParameter::QUmlOperationTemplateParameter(bool createQModel _qModelingObject = qobject_cast<QModelingObject *>(new QUmlOperationTemplateParameterObject(this)); } +/*! + Returns a deep-copied clone of the QUmlOperationTemplateParameter. +*/ QModelingElement *QUmlOperationTemplateParameter::clone() const { QUmlOperationTemplateParameter *c = new QUmlOperationTemplateParameter; @@ -87,6 +94,10 @@ QModelingElement *QUmlOperationTemplateParameter::clone() const /*! The operation for this template parameter. + + \b {Redefined property(ies):} QUmlTemplateParameter::parameteredElement(). + + \b {Opposite property(ies):} QUmlOperation::templateParameter(). */ QUmlOperation *QUmlOperationTemplateParameter::parameteredElement() const { @@ -95,6 +106,9 @@ QUmlOperation *QUmlOperationTemplateParameter::parameteredElement() const return _parameteredElement; } +/*! + Adjusts parameteredElement to \a parameteredElement. + */ void QUmlOperationTemplateParameter::setParameteredElement(QUmlOperation *parameteredElement) { // This is a read-write association end diff --git a/src/uml/qumloperationtemplateparameter.h b/src/uml/qumloperationtemplateparameter.h index 2e0e436b..ff27189d 100644 --- a/src/uml/qumloperationtemplateparameter.h +++ b/src/uml/qumloperationtemplateparameter.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlTemplateParameter> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlOperationTemplateParameter) *) -QT_END_HEADER - #endif // QUMLOPERATIONTEMPLATEPARAMETER_H diff --git a/src/uml/qumloutputpin.cpp b/src/uml/qumloutputpin.cpp index 8aabc923..19e9bd82 100644 --- a/src/uml/qumloutputpin.cpp +++ b/src/uml/qumloutputpin.cpp @@ -73,12 +73,19 @@ QT_BEGIN_NAMESPACE \brief An output pin is a pin that holds output values produced by an action. */ + +/*! + Creates a new QUmlOutputPin. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlOutputPin::QUmlOutputPin(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlOutputPinObject(this)); } +/*! + Returns a deep-copied clone of the QUmlOutputPin. +*/ QModelingElement *QUmlOutputPin::clone() const { QUmlOutputPin *c = new QUmlOutputPin; diff --git a/src/uml/qumloutputpin.h b/src/uml/qumloutputpin.h index f9d7b663..c79b1f6a 100644 --- a/src/uml/qumloutputpin.h +++ b/src/uml/qumloutputpin.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlPin> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlOutputPin) *) -QT_END_HEADER - #endif // QUMLOUTPUTPIN_H diff --git a/src/uml/qumlpackage.cpp b/src/uml/qumlpackage.cpp index d1a3c47d..931ed763 100644 --- a/src/uml/qumlpackage.cpp +++ b/src/uml/qumlpackage.cpp @@ -69,6 +69,10 @@ QT_BEGIN_NAMESPACE \brief A package can have one or more profile applications to indicate which profiles have been applied. Because a profile is a package, it is possible to apply a profile not only to packages, but also to profiles.Package specializes TemplateableElement and PackageableElement specializes ParameterableElement to specify that a package can be used as a template and a PackageableElement as a template parameter.A package is used to group elements, and provides a namespace for the grouped elements. */ + +/*! + Creates a new QUmlPackage. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlPackage::QUmlPackage(bool createQModelingObject) : _nestingPackage(0) { @@ -76,6 +80,9 @@ QUmlPackage::QUmlPackage(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlPackageObject(this)); } +/*! + Returns a deep-copied clone of the QUmlPackage. +*/ QModelingElement *QUmlPackage::clone() const { QUmlPackage *c = new QUmlPackage; @@ -125,6 +132,9 @@ QString QUmlPackage::URI() const return _URI; } +/*! + Adjusts URI to \a URI. + */ void QUmlPackage::setURI(QString URI) { // This is a read-write property @@ -136,6 +146,14 @@ void QUmlPackage::setURI(QString URI) /*! References the packaged elements that are Packages. + + \sa addNestedPackage(), removeNestedPackage() + + \b {This is a derived property.} + + \b {Subsetted property(ies):} QUmlPackage::packagedElements(). + + \b {Opposite property(ies):} QUmlPackage::nestingPackage(). */ const QSet<QUmlPackage *> QUmlPackage::nestedPackages() const { @@ -148,6 +166,11 @@ const QSet<QUmlPackage *> QUmlPackage::nestedPackages() const return nestedPackages_; } +/*! + Adds \a nestedPackage to nestedPackages. + + \sa nestedPackages(), removeNestedPackage() + */ void QUmlPackage::addNestedPackage(QUmlPackage *nestedPackage) { // This is a read-write derived association end @@ -163,6 +186,11 @@ void QUmlPackage::addNestedPackage(QUmlPackage *nestedPackage) } } +/*! + Removes \a nestedPackage from nestedPackages. + + \sa nestedPackages(), addNestedPackage() + */ void QUmlPackage::removeNestedPackage(QUmlPackage *nestedPackage) { // This is a read-write derived association end @@ -180,6 +208,10 @@ void QUmlPackage::removeNestedPackage(QUmlPackage *nestedPackage) /*! References the Package that owns this Package. + + \b {Subsetted property(ies):} . + + \b {Opposite property(ies):} QUmlPackage::nestedPackages(). */ QUmlPackage *QUmlPackage::nestingPackage() const { @@ -188,6 +220,9 @@ QUmlPackage *QUmlPackage::nestingPackage() const return _nestingPackage; } +/*! + Adjusts nestingPackage to \a nestingPackage. + */ void QUmlPackage::setNestingPackage(QUmlPackage *nestingPackage) { // This is a read-write association end @@ -201,6 +236,10 @@ void QUmlPackage::setNestingPackage(QUmlPackage *nestingPackage) /*! References the Stereotypes that are owned by the Package + + \b {This is a read-only derived property.} + + \b {Subsetted property(ies):} QUmlPackage::packagedElements(). */ const QSet<QUmlStereotype *> QUmlPackage::ownedStereotypes() const { @@ -213,6 +252,11 @@ const QSet<QUmlStereotype *> QUmlPackage::ownedStereotypes() const return ownedStereotypes_; } +/*! + Adds \a ownedStereotype to ownedStereotypes. + + \sa ownedStereotypes(), removeOwnedStereotype() + */ void QUmlPackage::addOwnedStereotype(QUmlStereotype *ownedStereotype) { // This is a read-only derived association end @@ -228,6 +272,11 @@ void QUmlPackage::addOwnedStereotype(QUmlStereotype *ownedStereotype) } } +/*! + Removes \a ownedStereotype from ownedStereotypes. + + \sa ownedStereotypes(), addOwnedStereotype() + */ void QUmlPackage::removeOwnedStereotype(QUmlStereotype *ownedStereotype) { // This is a read-only derived association end @@ -245,6 +294,14 @@ void QUmlPackage::removeOwnedStereotype(QUmlStereotype *ownedStereotype) /*! References the packaged elements that are Types. + + \sa addOwnedType(), removeOwnedType() + + \b {This is a derived property.} + + \b {Subsetted property(ies):} QUmlPackage::packagedElements(). + + \b {Opposite property(ies):} QUmlType::package(). */ const QSet<QUmlType *> QUmlPackage::ownedTypes() const { @@ -257,6 +314,11 @@ const QSet<QUmlType *> QUmlPackage::ownedTypes() const return ownedTypes_; } +/*! + Adds \a ownedType to ownedTypes. + + \sa ownedTypes(), removeOwnedType() + */ void QUmlPackage::addOwnedType(QUmlType *ownedType) { // This is a read-write derived association end @@ -272,6 +334,11 @@ void QUmlPackage::addOwnedType(QUmlType *ownedType) } } +/*! + Removes \a ownedType from ownedTypes. + + \sa ownedTypes(), addOwnedType() + */ void QUmlPackage::removeOwnedType(QUmlType *ownedType) { // This is a read-write derived association end @@ -289,6 +356,12 @@ void QUmlPackage::removeOwnedType(QUmlType *ownedType) /*! References the PackageMerges that are owned by this Package. + + \sa addPackageMerge(), removePackageMerge() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlPackageMerge::receivingPackage(). */ const QSet<QUmlPackageMerge *> QUmlPackage::packageMerges() const { @@ -297,6 +370,11 @@ const QSet<QUmlPackageMerge *> QUmlPackage::packageMerges() const return _packageMerges; } +/*! + Adds \a packageMerge to packageMerges. + + \sa packageMerges(), removePackageMerge() + */ void QUmlPackage::addPackageMerge(QUmlPackageMerge *packageMerge) { // This is a read-write association end @@ -317,6 +395,11 @@ void QUmlPackage::addPackageMerge(QUmlPackageMerge *packageMerge) } } +/*! + Removes \a packageMerge from packageMerges. + + \sa packageMerges(), addPackageMerge() + */ void QUmlPackage::removePackageMerge(QUmlPackageMerge *packageMerge) { // This is a read-write association end @@ -338,6 +421,10 @@ void QUmlPackage::removePackageMerge(QUmlPackageMerge *packageMerge) /*! Specifies the packageable elements that are owned by this Package. + + \sa addPackagedElement(), removePackagedElement() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). */ const QSet<QUmlPackageableElement *> QUmlPackage::packagedElements() const { @@ -346,6 +433,11 @@ const QSet<QUmlPackageableElement *> QUmlPackage::packagedElements() const return _packagedElements; } +/*! + Adds \a packagedElement to packagedElements. + + \sa packagedElements(), removePackagedElement() + */ void QUmlPackage::addPackagedElement(QUmlPackageableElement *packagedElement) { // This is a read-write association end @@ -361,6 +453,11 @@ void QUmlPackage::addPackagedElement(QUmlPackageableElement *packagedElement) } } +/*! + Removes \a packagedElement from packagedElements. + + \sa packagedElements(), addPackagedElement() + */ void QUmlPackage::removePackagedElement(QUmlPackageableElement *packagedElement) { // This is a read-write association end @@ -377,6 +474,12 @@ void QUmlPackage::removePackagedElement(QUmlPackageableElement *packagedElement) /*! References the ProfileApplications that indicate which profiles have been applied to the Package. + + \sa addProfileApplication(), removeProfileApplication() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlProfileApplication::applyingPackage(). */ const QSet<QUmlProfileApplication *> QUmlPackage::profileApplications() const { @@ -385,6 +488,11 @@ const QSet<QUmlProfileApplication *> QUmlPackage::profileApplications() const return _profileApplications; } +/*! + Adds \a profileApplication to profileApplications. + + \sa profileApplications(), removeProfileApplication() + */ void QUmlPackage::addProfileApplication(QUmlProfileApplication *profileApplication) { // This is a read-write association end @@ -405,6 +513,11 @@ void QUmlPackage::addProfileApplication(QUmlProfileApplication *profileApplicati } } +/*! + Removes \a profileApplication from profileApplications. + + \sa profileApplications(), addProfileApplication() + */ void QUmlPackage::removeProfileApplication(QUmlProfileApplication *profileApplication) { // This is a read-write association end diff --git a/src/uml/qumlpackage.h b/src/uml/qumlpackage.h index d53adc1d..1a4ae431 100644 --- a/src/uml/qumlpackage.h +++ b/src/uml/qumlpackage.h @@ -47,8 +47,6 @@ #include <QtUml/QUmlPackageableElement> #include <QtUml/QUmlTemplateableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -110,7 +108,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlPackage) *) -QT_END_HEADER - #endif // QUMLPACKAGE_H diff --git a/src/uml/qumlpackageableelement.cpp b/src/uml/qumlpackageableelement.cpp index bdd4addf..c0fcd5e0 100644 --- a/src/uml/qumlpackageableelement.cpp +++ b/src/uml/qumlpackageableelement.cpp @@ -56,12 +56,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief Packageable elements are able to serve as a template parameter.A packageable element indicates a named element that may be owned directly by a package. + + \b {QUmlPackageableElement is an abstract class.} */ + +/*! + Creates a new QUmlPackageableElement. +*/ QUmlPackageableElement::QUmlPackageableElement() : _visibility(QtUml::VisibilityKindPublic) { } +/*! + Returns a deep-copied clone of the QUmlPackageableElement. +*/ QModelingElement *QUmlPackageableElement::clone() const { QUmlPackageableElement *c = new QUmlPackageableElement; @@ -84,6 +93,8 @@ QModelingElement *QUmlPackageableElement::clone() const /*! Indicates that packageable elements must always have a visibility, i.e., visibility is not optional. + + \b {Redefined property(ies):} QUmlNamedElement::visibility(). */ QtUml::VisibilityKind QUmlPackageableElement::visibility() const { @@ -92,6 +103,9 @@ QtUml::VisibilityKind QUmlPackageableElement::visibility() const return _visibility; } +/*! + Adjusts visibility to \a visibility. + */ void QUmlPackageableElement::setVisibility(QtUml::VisibilityKind visibility) { // This is a read-write property diff --git a/src/uml/qumlpackageableelement.h b/src/uml/qumlpackageableelement.h index 050274e2..7563572e 100644 --- a/src/uml/qumlpackageableelement.h +++ b/src/uml/qumlpackageableelement.h @@ -48,8 +48,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -73,7 +71,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlPackageableElement) *) -QT_END_HEADER - #endif // QUMLPACKAGEABLEELEMENT_H diff --git a/src/uml/qumlpackageimport.cpp b/src/uml/qumlpackageimport.cpp index b0c5767c..cb8d1fb2 100644 --- a/src/uml/qumlpackageimport.cpp +++ b/src/uml/qumlpackageimport.cpp @@ -56,6 +56,10 @@ QT_BEGIN_NAMESPACE \brief A package import is a relationship that allows the use of unqualified names to refer to package members from other namespaces. */ + +/*! + Creates a new QUmlPackageImport. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlPackageImport::QUmlPackageImport(bool createQModelingObject) : _importedPackage(0), _importingNamespace(0), @@ -65,6 +69,9 @@ QUmlPackageImport::QUmlPackageImport(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlPackageImportObject(this)); } +/*! + Returns a deep-copied clone of the QUmlPackageImport. +*/ QModelingElement *QUmlPackageImport::clone() const { QUmlPackageImport *c = new QUmlPackageImport; @@ -82,6 +89,8 @@ QModelingElement *QUmlPackageImport::clone() const /*! Specifies the Package whose members are imported into a Namespace. + + \b {Subsetted property(ies):} QUmlDirectedRelationship::targets(). */ QUmlPackage *QUmlPackageImport::importedPackage() const { @@ -90,6 +99,9 @@ QUmlPackage *QUmlPackageImport::importedPackage() const return _importedPackage; } +/*! + Adjusts importedPackage to \a importedPackage. + */ void QUmlPackageImport::setImportedPackage(QUmlPackage *importedPackage) { // This is a read-write association end @@ -111,6 +123,10 @@ void QUmlPackageImport::setImportedPackage(QUmlPackage *importedPackage) /*! Specifies the Namespace that imports the members from a Package. + + \b {Subsetted property(ies):} QUmlElement::owner(), QUmlDirectedRelationship::sources(). + + \b {Opposite property(ies):} QUmlNamespace::packageImports(). */ QUmlNamespace *QUmlPackageImport::importingNamespace() const { @@ -119,6 +135,9 @@ QUmlNamespace *QUmlPackageImport::importingNamespace() const return _importingNamespace; } +/*! + Adjusts importingNamespace to \a importingNamespace. + */ void QUmlPackageImport::setImportingNamespace(QUmlNamespace *importingNamespace) { // This is a read-write association end @@ -149,6 +168,9 @@ QtUml::VisibilityKind QUmlPackageImport::visibility() const return _visibility; } +/*! + Adjusts visibility to \a visibility. + */ void QUmlPackageImport::setVisibility(QtUml::VisibilityKind visibility) { // This is a read-write property diff --git a/src/uml/qumlpackageimport.h b/src/uml/qumlpackageimport.h index 9684125e..967b3f7e 100644 --- a/src/uml/qumlpackageimport.h +++ b/src/uml/qumlpackageimport.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlPackageImport) *) -QT_END_HEADER - #endif // QUMLPACKAGEIMPORT_H diff --git a/src/uml/qumlpackagemerge.cpp b/src/uml/qumlpackagemerge.cpp index a3643b2c..78fe22ba 100644 --- a/src/uml/qumlpackagemerge.cpp +++ b/src/uml/qumlpackagemerge.cpp @@ -55,6 +55,10 @@ QT_BEGIN_NAMESPACE \brief A package merge defines how the contents of one package are extended by the contents of another package. */ + +/*! + Creates a new QUmlPackageMerge. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlPackageMerge::QUmlPackageMerge(bool createQModelingObject) : _mergedPackage(0), _receivingPackage(0) @@ -63,6 +67,9 @@ QUmlPackageMerge::QUmlPackageMerge(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlPackageMergeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlPackageMerge. +*/ QModelingElement *QUmlPackageMerge::clone() const { QUmlPackageMerge *c = new QUmlPackageMerge; @@ -79,6 +86,8 @@ QModelingElement *QUmlPackageMerge::clone() const /*! References the Package that is to be merged with the receiving package of the PackageMerge. + + \b {Subsetted property(ies):} QUmlDirectedRelationship::targets(). */ QUmlPackage *QUmlPackageMerge::mergedPackage() const { @@ -87,6 +96,9 @@ QUmlPackage *QUmlPackageMerge::mergedPackage() const return _mergedPackage; } +/*! + Adjusts mergedPackage to \a mergedPackage. + */ void QUmlPackageMerge::setMergedPackage(QUmlPackage *mergedPackage) { // This is a read-write association end @@ -108,6 +120,10 @@ void QUmlPackageMerge::setMergedPackage(QUmlPackage *mergedPackage) /*! References the Package that is being extended with the contents of the merged package of the PackageMerge. + + \b {Subsetted property(ies):} QUmlElement::owner(), QUmlDirectedRelationship::sources(). + + \b {Opposite property(ies):} QUmlPackage::packageMerges(). */ QUmlPackage *QUmlPackageMerge::receivingPackage() const { @@ -116,6 +132,9 @@ QUmlPackage *QUmlPackageMerge::receivingPackage() const return _receivingPackage; } +/*! + Adjusts receivingPackage to \a receivingPackage. + */ void QUmlPackageMerge::setReceivingPackage(QUmlPackage *receivingPackage) { // This is a read-write association end diff --git a/src/uml/qumlpackagemerge.h b/src/uml/qumlpackagemerge.h index cd1d58ab..eb4def32 100644 --- a/src/uml/qumlpackagemerge.h +++ b/src/uml/qumlpackagemerge.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlDirectedRelationship> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlPackageMerge) *) -QT_END_HEADER - #endif // QUMLPACKAGEMERGE_H diff --git a/src/uml/qumlparameter.cpp b/src/uml/qumlparameter.cpp index 5f5deb61..58e77f62 100644 --- a/src/uml/qumlparameter.cpp +++ b/src/uml/qumlparameter.cpp @@ -67,6 +67,10 @@ QT_BEGIN_NAMESPACE \brief Parameters are allowed to be treated as connectable elements.A parameter is a specification of an argument used to pass information into or out of an invocation of a behavioral feature.Parameters have support for streaming, exceptions, and parameter sets. */ + +/*! + Creates a new QUmlParameter. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlParameter::QUmlParameter(bool createQModelingObject) : _defaultValue(0), _direction(QtUml::ParameterDirectionKindIn), @@ -79,6 +83,9 @@ QUmlParameter::QUmlParameter(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlParameterObject(this)); } +/*! + Returns a deep-copied clone of the QUmlParameter. +*/ QModelingElement *QUmlParameter::clone() const { QUmlParameter *c = new QUmlParameter; @@ -119,6 +126,8 @@ QModelingElement *QUmlParameter::clone() const /*! Specifies a String that represents a value to be used when no argument is supplied for the Parameter. + + \b {This is a derived property.} */ QString QUmlParameter::default_() const { @@ -129,6 +138,9 @@ QString QUmlParameter::default_() const return QString(); } +/*! + Adjusts default_ to \a default_. + */ void QUmlParameter::setDefault(QString default_) { // This is a read-write derived property @@ -143,6 +155,8 @@ void QUmlParameter::setDefault(QString default_) /*! Specifies a ValueSpecification that represents a value to be used when no argument is supplied for the Parameter. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlParameter::defaultValue() const { @@ -151,6 +165,9 @@ QUmlValueSpecification *QUmlParameter::defaultValue() const return _defaultValue; } +/*! + Adjusts defaultValue to \a defaultValue. + */ void QUmlParameter::setDefaultValue(QUmlValueSpecification *defaultValue) { // This is a read-write association end @@ -181,6 +198,9 @@ QtUml::ParameterDirectionKind QUmlParameter::direction() const return _direction; } +/*! + Adjusts direction to \a direction. + */ void QUmlParameter::setDirection(QtUml::ParameterDirectionKind direction) { // This is a read-write property @@ -201,6 +221,9 @@ QtUml::ParameterEffectKind QUmlParameter::effect() const return _effect; } +/*! + Adjusts effect to \a effect. + */ void QUmlParameter::setEffect(QtUml::ParameterEffectKind effect) { // This is a read-write property @@ -220,6 +243,9 @@ bool QUmlParameter::isException() const return _isException; } +/*! + Adjusts isException to \a isException. + */ void QUmlParameter::setException(bool isException) { // This is a read-write property @@ -240,6 +266,9 @@ bool QUmlParameter::isStream() const return _isStream; } +/*! + Adjusts isStream to \a isStream. + */ void QUmlParameter::setStream(bool isStream) { // This is a read-write property @@ -252,6 +281,10 @@ void QUmlParameter::setStream(bool isStream) /*! References the Operation owning this parameter. + + \b {Subsetted property(ies):} . + + \b {Opposite property(ies):} QUmlOperation::ownedParameters(). */ QUmlOperation *QUmlParameter::operation() const { @@ -260,6 +293,9 @@ QUmlOperation *QUmlParameter::operation() const return _operation; } +/*! + Adjusts operation to \a operation. + */ void QUmlParameter::setOperation(QUmlOperation *operation) { // This is a read-write association end @@ -273,6 +309,10 @@ void QUmlParameter::setOperation(QUmlOperation *operation) /*! The parameter sets containing the parameter. See ParameterSet. + + \sa addParameterSet(), removeParameterSet() + + \b {Opposite property(ies):} QUmlParameterSet::parameters(). */ const QSet<QUmlParameterSet *> QUmlParameter::parameterSets() const { @@ -281,6 +321,11 @@ const QSet<QUmlParameterSet *> QUmlParameter::parameterSets() const return _parameterSets; } +/*! + Adds \a parameterSet to parameterSets. + + \sa parameterSets(), removeParameterSet() + */ void QUmlParameter::addParameterSet(QUmlParameterSet *parameterSet) { // This is a read-write association end @@ -297,6 +342,11 @@ void QUmlParameter::addParameterSet(QUmlParameterSet *parameterSet) } } +/*! + Removes \a parameterSet from parameterSets. + + \sa parameterSets(), addParameterSet() + */ void QUmlParameter::removeParameterSet(QUmlParameterSet *parameterSet) { // This is a read-write association end diff --git a/src/uml/qumlparameter.h b/src/uml/qumlparameter.h index e7ee4b08..07d2789f 100644 --- a/src/uml/qumlparameter.h +++ b/src/uml/qumlparameter.h @@ -48,8 +48,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -98,7 +96,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlParameter) *) -QT_END_HEADER - #endif // QUMLPARAMETER_H diff --git a/src/uml/qumlparameterableelement.cpp b/src/uml/qumlparameterableelement.cpp index 425f8aae..34d059f3 100644 --- a/src/uml/qumlparameterableelement.cpp +++ b/src/uml/qumlparameterableelement.cpp @@ -51,13 +51,22 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A parameterable element is an element that can be exposed as a formal template parameter for a template, or specified as an actual parameter in a binding of a template. + + \b {QUmlParameterableElement is an abstract class.} */ + +/*! + Creates a new QUmlParameterableElement. +*/ QUmlParameterableElement::QUmlParameterableElement() : _owningTemplateParameter(0), _templateParameter(0) { } +/*! + Returns a deep-copied clone of the QUmlParameterableElement. +*/ QModelingElement *QUmlParameterableElement::clone() const { QUmlParameterableElement *c = new QUmlParameterableElement; @@ -74,6 +83,10 @@ QModelingElement *QUmlParameterableElement::clone() const /*! The formal template parameter that owns this element. + + \b {Subsetted property(ies):} QUmlParameterableElement::templateParameter(), QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlTemplateParameter::ownedParameteredElement(). */ QUmlTemplateParameter *QUmlParameterableElement::owningTemplateParameter() const { @@ -82,6 +95,9 @@ QUmlTemplateParameter *QUmlParameterableElement::owningTemplateParameter() const return _owningTemplateParameter; } +/*! + Adjusts owningTemplateParameter to \a owningTemplateParameter. + */ void QUmlParameterableElement::setOwningTemplateParameter(QUmlTemplateParameter *owningTemplateParameter) { // This is a read-write association end @@ -101,6 +117,8 @@ void QUmlParameterableElement::setOwningTemplateParameter(QUmlTemplateParameter /*! The template parameter that exposes this element as a formal parameter. + + \b {Opposite property(ies):} QUmlTemplateParameter::parameteredElement(). */ QUmlTemplateParameter *QUmlParameterableElement::templateParameter() const { @@ -109,6 +127,9 @@ QUmlTemplateParameter *QUmlParameterableElement::templateParameter() const return _templateParameter; } +/*! + Adjusts templateParameter to \a templateParameter. + */ void QUmlParameterableElement::setTemplateParameter(QUmlTemplateParameter *templateParameter) { // This is a read-write association end diff --git a/src/uml/qumlparameterableelement.h b/src/uml/qumlparameterableelement.h index 0f501b81..73658939 100644 --- a/src/uml/qumlparameterableelement.h +++ b/src/uml/qumlparameterableelement.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -79,7 +77,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlParameterableElement) *) -QT_END_HEADER - #endif // QUMLPARAMETERABLEELEMENT_H diff --git a/src/uml/qumlparameterset.cpp b/src/uml/qumlparameterset.cpp index 76a1b348..b8486fa5 100644 --- a/src/uml/qumlparameterset.cpp +++ b/src/uml/qumlparameterset.cpp @@ -60,12 +60,19 @@ QT_BEGIN_NAMESPACE \brief A parameter set is an element that provides alternative sets of inputs or outputs that a behavior may use. */ + +/*! + Creates a new QUmlParameterSet. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlParameterSet::QUmlParameterSet(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlParameterSetObject(this)); } +/*! + Returns a deep-copied clone of the QUmlParameterSet. +*/ QModelingElement *QUmlParameterSet::clone() const { QUmlParameterSet *c = new QUmlParameterSet; @@ -88,6 +95,10 @@ QModelingElement *QUmlParameterSet::clone() const /*! Constraint that should be satisfied for the owner of the parameters in an input parameter set to start execution using the values provided for those parameters, or the owner of the parameters in an output parameter set to end execution providing the values for those parameters, if all preconditions and conditions on input parameter sets were satisfied. + + \sa addCondition(), removeCondition() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlConstraint *> QUmlParameterSet::conditions() const { @@ -96,6 +107,11 @@ const QSet<QUmlConstraint *> QUmlParameterSet::conditions() const return _conditions; } +/*! + Adds \a condition to conditions. + + \sa conditions(), removeCondition() + */ void QUmlParameterSet::addCondition(QUmlConstraint *condition) { // This is a read-write association end @@ -111,6 +127,11 @@ void QUmlParameterSet::addCondition(QUmlConstraint *condition) } } +/*! + Removes \a condition from conditions. + + \sa conditions(), addCondition() + */ void QUmlParameterSet::removeCondition(QUmlConstraint *condition) { // This is a read-write association end @@ -127,6 +148,10 @@ void QUmlParameterSet::removeCondition(QUmlConstraint *condition) /*! Parameters in the parameter set. + + \sa addParameter(), removeParameter() + + \b {Opposite property(ies):} QUmlParameter::parameterSets(). */ const QSet<QUmlParameter *> QUmlParameterSet::parameters() const { @@ -135,6 +160,11 @@ const QSet<QUmlParameter *> QUmlParameterSet::parameters() const return _parameters; } +/*! + Adds \a parameter to parameters. + + \sa parameters(), removeParameter() + */ void QUmlParameterSet::addParameter(QUmlParameter *parameter) { // This is a read-write association end @@ -151,6 +181,11 @@ void QUmlParameterSet::addParameter(QUmlParameter *parameter) } } +/*! + Removes \a parameter from parameters. + + \sa parameters(), addParameter() + */ void QUmlParameterSet::removeParameter(QUmlParameter *parameter) { // This is a read-write association end diff --git a/src/uml/qumlparameterset.h b/src/uml/qumlparameterset.h index 73532d3a..580f3ca7 100644 --- a/src/uml/qumlparameterset.h +++ b/src/uml/qumlparameterset.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -78,7 +76,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlParameterSet) *) -QT_END_HEADER - #endif // QUMLPARAMETERSET_H diff --git a/src/uml/qumlpartdecomposition.cpp b/src/uml/qumlpartdecomposition.cpp index 22c89dfa..e39db906 100644 --- a/src/uml/qumlpartdecomposition.cpp +++ b/src/uml/qumlpartdecomposition.cpp @@ -66,6 +66,10 @@ QT_BEGIN_NAMESPACE \brief A part decomposition is a description of the internal interactions of one lifeline relative to an interaction. */ + +/*! + Creates a new QUmlPartDecomposition. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlPartDecomposition::QUmlPartDecomposition(bool createQModelingObject) : QUmlInteractionUse(false) { @@ -73,6 +77,9 @@ QUmlPartDecomposition::QUmlPartDecomposition(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlPartDecompositionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlPartDecomposition. +*/ QModelingElement *QUmlPartDecomposition::clone() const { QUmlPartDecomposition *c = new QUmlPartDecomposition; diff --git a/src/uml/qumlpartdecomposition.h b/src/uml/qumlpartdecomposition.h index ac338c3c..88db101d 100644 --- a/src/uml/qumlpartdecomposition.h +++ b/src/uml/qumlpartdecomposition.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInteractionUse> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlPartDecomposition) *) -QT_END_HEADER - #endif // QUMLPARTDECOMPOSITION_H diff --git a/src/uml/qumlpin.cpp b/src/uml/qumlpin.cpp index a8051ca8..9fdec196 100644 --- a/src/uml/qumlpin.cpp +++ b/src/uml/qumlpin.cpp @@ -69,12 +69,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A pin is a typed element and multiplicity element that provides values to actions and accept result values from them.A pin is an object node for inputs and outputs to actions. + + \b {QUmlPin is an abstract class.} */ + +/*! + Creates a new QUmlPin. +*/ QUmlPin::QUmlPin() : _isControl(false) { } +/*! + Returns a deep-copied clone of the QUmlPin. +*/ QModelingElement *QUmlPin::clone() const { QUmlPin *c = new QUmlPin; @@ -133,6 +142,9 @@ bool QUmlPin::isControl() const return _isControl; } +/*! + Adjusts isControl to \a isControl. + */ void QUmlPin::setControl(bool isControl) { // This is a read-write property diff --git a/src/uml/qumlpin.h b/src/uml/qumlpin.h index 38277fe8..37e49f1b 100644 --- a/src/uml/qumlpin.h +++ b/src/uml/qumlpin.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlMultiplicityElement> #include <QtUml/QUmlObjectNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -71,7 +69,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlPin) *) -QT_END_HEADER - #endif // QUMLPIN_H diff --git a/src/uml/qumlport.cpp b/src/uml/qumlport.cpp index 6d2812b6..517c33d5 100644 --- a/src/uml/qumlport.cpp +++ b/src/uml/qumlport.cpp @@ -78,6 +78,10 @@ QT_BEGIN_NAMESPACE \brief A port has an associated protocol state machine.A port is a property of a classifier that specifies a distinct interaction point between that classifier and its environment or between the (behavior of the) classifier and its internal parts. Ports are connected to properties of the classifier by connectors through which requests can be made to invoke the behavioral features of a classifier. A Port may specify the services a classifier provides (offers) to its environment as well as the services that a classifier expects (requires) of its environment. */ + +/*! + Creates a new QUmlPort. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlPort::QUmlPort(bool createQModelingObject) : QUmlProperty(false), _isBehavior(false), @@ -89,6 +93,9 @@ QUmlPort::QUmlPort(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlPortObject(this)); } +/*! + Returns a deep-copied clone of the QUmlPort. +*/ QModelingElement *QUmlPort::clone() const { QUmlPort *c = new QUmlPort; @@ -163,6 +170,9 @@ bool QUmlPort::isBehavior() const return _isBehavior; } +/*! + Adjusts isBehavior to \a isBehavior. + */ void QUmlPort::setBehavior(bool isBehavior) { // This is a read-write property @@ -183,6 +193,9 @@ bool QUmlPort::isConjugated() const return _isConjugated; } +/*! + Adjusts isConjugated to \a isConjugated. + */ void QUmlPort::setConjugated(bool isConjugated) { // This is a read-write property @@ -203,6 +216,9 @@ bool QUmlPort::isService() const return _isService; } +/*! + Adjusts isService to \a isService. + */ void QUmlPort::setService(bool isService) { // This is a read-write property @@ -223,6 +239,9 @@ QUmlProtocolStateMachine *QUmlPort::protocol() const return _protocol; } +/*! + Adjusts protocol to \a protocol. + */ void QUmlPort::setProtocol(QUmlProtocolStateMachine *protocol) { // This is a read-write association end @@ -236,6 +255,8 @@ void QUmlPort::setProtocol(QUmlProtocolStateMachine *protocol) /*! References the interfaces specifying the set of operations and receptions that the classifier offers to its environment via this port, and which it will handle either directly or by forwarding it to a part of its internal structure. This association is derived according to the value of isConjugated. If isConjugated is false, provided is derived as the union of the sets of interfaces realized by the type of the port and its supertypes, or directly from the type of the port if the port is typed by an interface. If isConjugated is true, it is derived as the union of the sets of interfaces used by the type of the port and its supertypes. + + \b {This is a read-only derived property.} */ const QSet<QUmlInterface *> QUmlPort::provided() const { @@ -257,6 +278,11 @@ const QSet<QUmlInterface *> QUmlPort::provided() const return provided_; } +/*! + Adds \a provided to provided. + + \sa provided(), removeProvided() + */ void QUmlPort::addProvided(QUmlInterface *provided) { // This is a read-only derived association end @@ -269,6 +295,11 @@ void QUmlPort::addProvided(QUmlInterface *provided) } } +/*! + Removes \a provided from provided. + + \sa provided(), addProvided() + */ void QUmlPort::removeProvided(QUmlInterface *provided) { // This is a read-only derived association end @@ -283,6 +314,10 @@ void QUmlPort::removeProvided(QUmlInterface *provided) /*! A port may be redefined when its containing classifier is specialized. The redefining port may have additional interfaces to those that are associated with the redefined port or it may replace an interface by one of its subtypes. + + \sa addRedefinedPort(), removeRedefinedPort() + + \b {Subsetted property(ies):} QUmlProperty::redefinedProperties(). */ const QSet<QUmlPort *> QUmlPort::redefinedPorts() const { @@ -291,6 +326,11 @@ const QSet<QUmlPort *> QUmlPort::redefinedPorts() const return _redefinedPorts; } +/*! + Adds \a redefinedPort to redefinedPorts. + + \sa redefinedPorts(), removeRedefinedPort() + */ void QUmlPort::addRedefinedPort(QUmlPort *redefinedPort) { // This is a read-write association end @@ -305,6 +345,11 @@ void QUmlPort::addRedefinedPort(QUmlPort *redefinedPort) } } +/*! + Removes \a redefinedPort from redefinedPorts. + + \sa redefinedPorts(), addRedefinedPort() + */ void QUmlPort::removeRedefinedPort(QUmlPort *redefinedPort) { // This is a read-write association end @@ -319,6 +364,8 @@ void QUmlPort::removeRedefinedPort(QUmlPort *redefinedPort) /*! References the interfaces specifying the set of operations and receptions that the classifier expects its environment to handle via this port. This association is derived according to the value of isConjugated. If isConjugated is false, required is derived as the union of the sets of interfaces used by the type of the port and its supertypes. If isConjugated is true, it is derived as the union of the sets of interfaces realized by the type of the port and its supertypes, or directly from the type of the port if the port is typed by an interface. + + \b {This is a read-only derived property.} */ const QSet<QUmlInterface *> QUmlPort::required() const { @@ -340,6 +387,11 @@ const QSet<QUmlInterface *> QUmlPort::required() const return required_; } +/*! + Adds \a required to required. + + \sa required(), removeRequired() + */ void QUmlPort::addRequired(QUmlInterface *required) { // This is a read-only derived association end @@ -352,6 +404,11 @@ void QUmlPort::addRequired(QUmlInterface *required) } } +/*! + Removes \a required from required. + + \sa required(), addRequired() + */ void QUmlPort::removeRequired(QUmlInterface *required) { // This is a read-only derived association end diff --git a/src/uml/qumlport.h b/src/uml/qumlport.h index edc1843a..dbaf387f 100644 --- a/src/uml/qumlport.h +++ b/src/uml/qumlport.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlProperty> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -98,7 +96,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlPort) *) -QT_END_HEADER - #endif // QUMLPORT_H diff --git a/src/uml/qumlprimitivetype.cpp b/src/uml/qumlprimitivetype.cpp index f2f80e5d..60309335 100644 --- a/src/uml/qumlprimitivetype.cpp +++ b/src/uml/qumlprimitivetype.cpp @@ -80,6 +80,10 @@ QT_BEGIN_NAMESPACE \brief A primitive type defines a predefined data type, without any relevant substructure (i.e., it has no parts in the context of UML). A primitive datatype may have an algebra and operations defined outside of UML, for example, mathematically. */ + +/*! + Creates a new QUmlPrimitiveType. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlPrimitiveType::QUmlPrimitiveType(bool createQModelingObject) : QUmlDataType(false) { @@ -87,6 +91,9 @@ QUmlPrimitiveType::QUmlPrimitiveType(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlPrimitiveTypeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlPrimitiveType. +*/ QModelingElement *QUmlPrimitiveType::clone() const { QUmlPrimitiveType *c = new QUmlPrimitiveType; diff --git a/src/uml/qumlprimitivetype.h b/src/uml/qumlprimitivetype.h index 5d9ee6ef..53bf80d2 100644 --- a/src/uml/qumlprimitivetype.h +++ b/src/uml/qumlprimitivetype.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlDataType> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlPrimitiveType) *) -QT_END_HEADER - #endif // QUMLPRIMITIVETYPE_H diff --git a/src/uml/qumlprofile.cpp b/src/uml/qumlprofile.cpp index d40c47c9..30dce22f 100644 --- a/src/uml/qumlprofile.cpp +++ b/src/uml/qumlprofile.cpp @@ -70,6 +70,10 @@ QT_BEGIN_NAMESPACE \brief A profile defines limited extensions to a reference metamodel with the purpose of adapting the metamodel to a specific platform or domain. */ + +/*! + Creates a new QUmlProfile. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlProfile::QUmlProfile(bool createQModelingObject) : QUmlPackage(false) { @@ -77,6 +81,9 @@ QUmlProfile::QUmlProfile(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlProfileObject(this)); } +/*! + Returns a deep-copied clone of the QUmlProfile. +*/ QModelingElement *QUmlProfile::clone() const { QUmlProfile *c = new QUmlProfile; @@ -122,6 +129,10 @@ QModelingElement *QUmlProfile::clone() const /*! References a metaclass that may be extended. + + \sa addMetaclassReference(), removeMetaclassReference() + + \b {Subsetted property(ies):} QUmlNamespace::elementImports(). */ const QSet<QUmlElementImport *> QUmlProfile::metaclassReferences() const { @@ -130,6 +141,11 @@ const QSet<QUmlElementImport *> QUmlProfile::metaclassReferences() const return _metaclassReferences; } +/*! + Adds \a metaclassReference to metaclassReferences. + + \sa metaclassReferences(), removeMetaclassReference() + */ void QUmlProfile::addMetaclassReference(QUmlElementImport *metaclassReference) { // This is a read-write association end @@ -145,6 +161,11 @@ void QUmlProfile::addMetaclassReference(QUmlElementImport *metaclassReference) } } +/*! + Removes \a metaclassReference from metaclassReferences. + + \sa metaclassReferences(), addMetaclassReference() + */ void QUmlProfile::removeMetaclassReference(QUmlElementImport *metaclassReference) { // This is a read-write association end @@ -161,6 +182,10 @@ void QUmlProfile::removeMetaclassReference(QUmlElementImport *metaclassReference /*! References a package containing (directly or indirectly) metaclasses that may be extended. + + \sa addMetamodelReference(), removeMetamodelReference() + + \b {Subsetted property(ies):} QUmlNamespace::packageImports(). */ const QSet<QUmlPackageImport *> QUmlProfile::metamodelReferences() const { @@ -169,6 +194,11 @@ const QSet<QUmlPackageImport *> QUmlProfile::metamodelReferences() const return _metamodelReferences; } +/*! + Adds \a metamodelReference to metamodelReferences. + + \sa metamodelReferences(), removeMetamodelReference() + */ void QUmlProfile::addMetamodelReference(QUmlPackageImport *metamodelReference) { // This is a read-write association end @@ -184,6 +214,11 @@ void QUmlProfile::addMetamodelReference(QUmlPackageImport *metamodelReference) } } +/*! + Removes \a metamodelReference from metamodelReferences. + + \sa metamodelReferences(), addMetamodelReference() + */ void QUmlProfile::removeMetamodelReference(QUmlPackageImport *metamodelReference) { // This is a read-write association end diff --git a/src/uml/qumlprofile.h b/src/uml/qumlprofile.h index 0c21ee2f..69de3ede 100644 --- a/src/uml/qumlprofile.h +++ b/src/uml/qumlprofile.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlPackage> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -78,7 +76,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlProfile) *) -QT_END_HEADER - #endif // QUMLPROFILE_H diff --git a/src/uml/qumlprofileapplication.cpp b/src/uml/qumlprofileapplication.cpp index 37f7bc5d..46ba18c7 100644 --- a/src/uml/qumlprofileapplication.cpp +++ b/src/uml/qumlprofileapplication.cpp @@ -56,6 +56,10 @@ QT_BEGIN_NAMESPACE \brief A profile application is used to show which profiles have been applied to a package. */ + +/*! + Creates a new QUmlProfileApplication. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlProfileApplication::QUmlProfileApplication(bool createQModelingObject) : _appliedProfile(0), _applyingPackage(0), @@ -65,6 +69,9 @@ QUmlProfileApplication::QUmlProfileApplication(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlProfileApplicationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlProfileApplication. +*/ QModelingElement *QUmlProfileApplication::clone() const { QUmlProfileApplication *c = new QUmlProfileApplication; @@ -82,6 +89,8 @@ QModelingElement *QUmlProfileApplication::clone() const /*! References the Profiles that are applied to a Package through this ProfileApplication. + + \b {Subsetted property(ies):} QUmlDirectedRelationship::targets(). */ QUmlProfile *QUmlProfileApplication::appliedProfile() const { @@ -90,6 +99,9 @@ QUmlProfile *QUmlProfileApplication::appliedProfile() const return _appliedProfile; } +/*! + Adjusts appliedProfile to \a appliedProfile. + */ void QUmlProfileApplication::setAppliedProfile(QUmlProfile *appliedProfile) { // This is a read-write association end @@ -111,6 +123,10 @@ void QUmlProfileApplication::setAppliedProfile(QUmlProfile *appliedProfile) /*! The package that owns the profile application. + + \b {Subsetted property(ies):} QUmlElement::owner(), QUmlDirectedRelationship::sources(). + + \b {Opposite property(ies):} QUmlPackage::profileApplications(). */ QUmlPackage *QUmlProfileApplication::applyingPackage() const { @@ -119,6 +135,9 @@ QUmlPackage *QUmlProfileApplication::applyingPackage() const return _applyingPackage; } +/*! + Adjusts applyingPackage to \a applyingPackage. + */ void QUmlProfileApplication::setApplyingPackage(QUmlPackage *applyingPackage) { // This is a read-write association end @@ -149,6 +168,9 @@ bool QUmlProfileApplication::isStrict() const return _isStrict; } +/*! + Adjusts isStrict to \a isStrict. + */ void QUmlProfileApplication::setStrict(bool isStrict) { // This is a read-write property diff --git a/src/uml/qumlprofileapplication.h b/src/uml/qumlprofileapplication.h index 564031b8..52c7ff32 100644 --- a/src/uml/qumlprofileapplication.h +++ b/src/uml/qumlprofileapplication.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlDirectedRelationship> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -79,7 +77,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlProfileApplication) *) -QT_END_HEADER - #endif // QUMLPROFILEAPPLICATION_H diff --git a/src/uml/qumlproperty.cpp b/src/uml/qumlproperty.cpp index 8b20ca78..a926e608 100644 --- a/src/uml/qumlproperty.cpp +++ b/src/uml/qumlproperty.cpp @@ -74,6 +74,10 @@ QT_BEGIN_NAMESPACE \brief Property represents a declared state of one or more instances in terms of a named relationship to a value or values. When a property is an attribute of a classifier, the value or values are related to the instance of the classifier by being held in slots of the instance. When a property is an association end, the value or values are related to the instance or instances at the other end(s) of the association. The range of valid values represented by the property can be controlled by setting the property's type.A property is a structural feature of a classifier that characterizes instances of the classifier. A property related by ownedAttribute to a classifier (other than an association) represents an attribute and might also represent an association end. It relates an instance of the class to a value or set of values of the type of the attribute. A property related by memberEnd or its specializations to an association represents an end of the association. The type of the property is the type of the end of the association.A property has the capability of being a deployment target in a deployment relationship. This enables modeling the deployment to hierarchical nodes that have properties functioning as internal parts.Property specializes ParameterableElement to specify that a property can be exposed as a formal template parameter, and provided as an actual parameter in a binding of a template.A property represents a set of instances that are owned by a containing classifier instance. */ + +/*! + Creates a new QUmlProperty. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlProperty::QUmlProperty(bool createQModelingObject) : _aggregation(QtUml::AggregationKindNone), _association(0), @@ -92,6 +96,9 @@ QUmlProperty::QUmlProperty(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlPropertyObject(this)); } +/*! + Returns a deep-copied clone of the QUmlProperty. +*/ QModelingElement *QUmlProperty::clone() const { QUmlProperty *c = new QUmlProperty; @@ -159,6 +166,9 @@ QtUml::AggregationKind QUmlProperty::aggregation() const return _aggregation; } +/*! + Adjusts aggregation to \a aggregation. + */ void QUmlProperty::setAggregation(QtUml::AggregationKind aggregation) { // This is a read-write property @@ -171,6 +181,10 @@ void QUmlProperty::setAggregation(QtUml::AggregationKind aggregation) /*! References the association of which this property is a member, if any. + + \b {Subsetted property(ies):} . + + \b {Opposite property(ies):} QUmlAssociation::memberEnds(). */ QUmlAssociation *QUmlProperty::association() const { @@ -179,6 +193,9 @@ QUmlAssociation *QUmlProperty::association() const return _association; } +/*! + Adjusts association to \a association. + */ void QUmlProperty::setAssociation(QUmlAssociation *association) { // This is a read-write association end @@ -192,6 +209,10 @@ void QUmlProperty::setAssociation(QUmlAssociation *association) /*! Designates the optional association end that owns a qualifier attribute. + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlProperty::qualifiers(). */ QUmlProperty *QUmlProperty::associationEnd() const { @@ -200,6 +221,9 @@ QUmlProperty *QUmlProperty::associationEnd() const return _associationEnd; } +/*! + Adjusts associationEnd to \a associationEnd. + */ void QUmlProperty::setAssociationEnd(QUmlProperty *associationEnd) { // This is a read-write association end @@ -218,6 +242,10 @@ void QUmlProperty::setAssociationEnd(QUmlProperty *associationEnd) /*! References the Class that owns the Property.References the Class that owns the Property. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlClass::ownedAttributes(). */ QUmlClass *QUmlProperty::class_() const { @@ -226,6 +254,9 @@ QUmlClass *QUmlProperty::class_() const return _class_; } +/*! + Adjusts class_ to \a class_. + */ void QUmlProperty::setClass(QUmlClass *class_) { // This is a read-write association end @@ -244,6 +275,10 @@ void QUmlProperty::setClass(QUmlClass *class_) /*! The DataType that owns this Property. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlDataType::ownedAttributes(). */ QUmlDataType *QUmlProperty::datatype() const { @@ -252,6 +287,9 @@ QUmlDataType *QUmlProperty::datatype() const return _datatype; } +/*! + Adjusts datatype to \a datatype. + */ void QUmlProperty::setDatatype(QUmlDataType *datatype) { // This is a read-write association end @@ -270,6 +308,8 @@ void QUmlProperty::setDatatype(QUmlDataType *datatype) /*! Specifies a String that represents a value to be used when no argument is supplied for the Property.A String that is evaluated to give a default value for the Property when an object of the owning Classifier is instantiated. + + \b {This is a derived property.} */ QString QUmlProperty::default_() const { @@ -280,6 +320,9 @@ QString QUmlProperty::default_() const return QString(); } +/*! + Adjusts default_ to \a default_. + */ void QUmlProperty::setDefault(QString default_) { // This is a read-write derived property @@ -294,6 +337,8 @@ void QUmlProperty::setDefault(QString default_) /*! A ValueSpecification that is evaluated to give a default value for the Property when an object of the owning Classifier is instantiated. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlProperty::defaultValue() const { @@ -302,6 +347,9 @@ QUmlValueSpecification *QUmlProperty::defaultValue() const return _defaultValue; } +/*! + Adjusts defaultValue to \a defaultValue. + */ void QUmlProperty::setDefaultValue(QUmlValueSpecification *defaultValue) { // This is a read-write association end @@ -324,6 +372,10 @@ void QUmlProperty::setDefaultValue(QUmlValueSpecification *defaultValue) /*! References the Interface that owns the Property + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlInterface::ownedAttributes(). */ QUmlInterface *QUmlProperty::interface_() const { @@ -332,6 +384,9 @@ QUmlInterface *QUmlProperty::interface_() const return _interface_; } +/*! + Adjusts interface_ to \a interface_. + */ void QUmlProperty::setInterface(QUmlInterface *interface_) { // This is a read-write association end @@ -350,6 +405,8 @@ void QUmlProperty::setInterface(QUmlInterface *interface_) /*! If isComposite is true, the object containing the attribute is a container for the object or value contained in the attribute.This is a derived value, indicating whether the aggregation of the Property is composite or not. + + \b {This is a derived property.} */ bool QUmlProperty::isComposite() const { @@ -358,6 +415,9 @@ bool QUmlProperty::isComposite() const return _aggregation == QtUml::AggregationKindComposite; } +/*! + Adjusts isComposite to \a isComposite. + */ void QUmlProperty::setComposite(bool isComposite) { // This is a read-write derived property @@ -380,6 +440,9 @@ bool QUmlProperty::isDerived() const return _isDerived; } +/*! + Adjusts isDerived to \a isDerived. + */ void QUmlProperty::setDerived(bool isDerived) { // This is a read-write property @@ -400,6 +463,9 @@ bool QUmlProperty::isDerivedUnion() const return _isDerivedUnion; } +/*! + Adjusts isDerivedUnion to \a isDerivedUnion. + */ void QUmlProperty::setDerivedUnion(bool isDerivedUnion) { // This is a read-write property @@ -420,6 +486,9 @@ bool QUmlProperty::isID() const return _isID; } +/*! + Adjusts isID to \a isID. + */ void QUmlProperty::setID(bool isID) { // This is a read-write property @@ -432,6 +501,8 @@ void QUmlProperty::setID(bool isID) /*! If true, the attribute may only be read, and not written.If isReadOnly is true, the attribute may not be written to after initialization. + + \b {Redefined property(ies):} QUmlStructuralFeature::isReadOnly(). */ bool QUmlProperty::isReadOnly() const { @@ -440,6 +511,9 @@ bool QUmlProperty::isReadOnly() const return _isReadOnly; } +/*! + Adjusts isReadOnly to \a isReadOnly. + */ void QUmlProperty::setReadOnly(bool isReadOnly) { // This is a read-write property @@ -455,6 +529,8 @@ void QUmlProperty::setReadOnly(bool isReadOnly) /*! In the case where the property is one navigable end of a binary association with both ends navigable, this gives the other end. + + \b {This is a derived property.} */ QUmlProperty *QUmlProperty::opposite() const { @@ -465,6 +541,9 @@ QUmlProperty *QUmlProperty::opposite() const return 0; } +/*! + Adjusts opposite to \a opposite. + */ void QUmlProperty::setOpposite(QUmlProperty *opposite) { // This is a read-write derived association end @@ -479,6 +558,10 @@ void QUmlProperty::setOpposite(QUmlProperty *opposite) /*! References the owning association of this property, if any. + + \b {Subsetted property(ies):} QUmlFeature::featuringClassifiers(), QUmlRedefinableElement::redefinitionContexts(), QUmlNamedElement::namespace_(), QUmlProperty::association(). + + \b {Opposite property(ies):} QUmlAssociation::ownedEnds(). */ QUmlAssociation *QUmlProperty::owningAssociation() const { @@ -487,6 +570,9 @@ QUmlAssociation *QUmlProperty::owningAssociation() const return _owningAssociation; } +/*! + Adjusts owningAssociation to \a owningAssociation. + */ void QUmlProperty::setOwningAssociation(QUmlAssociation *owningAssociation) { // This is a read-write association end @@ -514,6 +600,12 @@ void QUmlProperty::setOwningAssociation(QUmlAssociation *owningAssociation) /*! An optional list of ordered qualifier attributes for the end. If the list is empty, then the Association is not qualified. + + \sa addQualifier(), removeQualifier() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlProperty::associationEnd(). */ const QList<QUmlProperty *> QUmlProperty::qualifiers() const { @@ -522,6 +614,11 @@ const QList<QUmlProperty *> QUmlProperty::qualifiers() const return _qualifiers; } +/*! + Adds \a qualifier to qualifiers. + + \sa qualifiers(), removeQualifier() + */ void QUmlProperty::addQualifier(QUmlProperty *qualifier) { // This is a read-write association end @@ -542,6 +639,11 @@ void QUmlProperty::addQualifier(QUmlProperty *qualifier) } } +/*! + Removes \a qualifier from qualifiers. + + \sa qualifiers(), addQualifier() + */ void QUmlProperty::removeQualifier(QUmlProperty *qualifier) { // This is a read-write association end @@ -563,6 +665,10 @@ void QUmlProperty::removeQualifier(QUmlProperty *qualifier) /*! References the properties that are redefined by this property. + + \sa addRedefinedProperty(), removeRedefinedProperty() + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinedElements(). */ const QSet<QUmlProperty *> QUmlProperty::redefinedProperties() const { @@ -571,6 +677,11 @@ const QSet<QUmlProperty *> QUmlProperty::redefinedProperties() const return _redefinedProperties; } +/*! + Adds \a redefinedProperty to redefinedProperties. + + \sa redefinedProperties(), removeRedefinedProperty() + */ void QUmlProperty::addRedefinedProperty(QUmlProperty *redefinedProperty) { // This is a read-write association end @@ -585,6 +696,11 @@ void QUmlProperty::addRedefinedProperty(QUmlProperty *redefinedProperty) } } +/*! + Removes \a redefinedProperty from redefinedProperties. + + \sa redefinedProperties(), addRedefinedProperty() + */ void QUmlProperty::removeRedefinedProperty(QUmlProperty *redefinedProperty) { // This is a read-write association end @@ -599,6 +715,8 @@ void QUmlProperty::removeRedefinedProperty(QUmlProperty *redefinedProperty) /*! References the properties of which this property is constrained to be a subset. + + \sa addSubsettedProperty(), removeSubsettedProperty() */ const QSet<QUmlProperty *> QUmlProperty::subsettedProperties() const { @@ -607,6 +725,11 @@ const QSet<QUmlProperty *> QUmlProperty::subsettedProperties() const return _subsettedProperties; } +/*! + Adds \a subsettedProperty to subsettedProperties. + + \sa subsettedProperties(), removeSubsettedProperty() + */ void QUmlProperty::addSubsettedProperty(QUmlProperty *subsettedProperty) { // This is a read-write association end @@ -618,6 +741,11 @@ void QUmlProperty::addSubsettedProperty(QUmlProperty *subsettedProperty) } } +/*! + Removes \a subsettedProperty from subsettedProperties. + + \sa subsettedProperties(), addSubsettedProperty() + */ void QUmlProperty::removeSubsettedProperty(QUmlProperty *subsettedProperty) { // This is a read-write association end diff --git a/src/uml/qumlproperty.h b/src/uml/qumlproperty.h index 720867f3..f07bd339 100644 --- a/src/uml/qumlproperty.h +++ b/src/uml/qumlproperty.h @@ -49,8 +49,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -141,7 +139,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlProperty) *) -QT_END_HEADER - #endif // QUMLPROPERTY_H diff --git a/src/uml/qumlprotocolconformance.cpp b/src/uml/qumlprotocolconformance.cpp index ab527994..4fab39bd 100644 --- a/src/uml/qumlprotocolconformance.cpp +++ b/src/uml/qumlprotocolconformance.cpp @@ -55,6 +55,10 @@ QT_BEGIN_NAMESPACE \brief Protocol state machines can be redefined into more specific protocol state machines, or into behavioral state machines. Protocol conformance declares that the specific protocol state machine specifies a protocol that conforms to the general state machine one, or that the specific behavioral state machine abide by the protocol of the general protocol state machine. */ + +/*! + Creates a new QUmlProtocolConformance. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlProtocolConformance::QUmlProtocolConformance(bool createQModelingObject) : _generalMachine(0), _specificMachine(0) @@ -63,6 +67,9 @@ QUmlProtocolConformance::QUmlProtocolConformance(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlProtocolConformanceObject(this)); } +/*! + Returns a deep-copied clone of the QUmlProtocolConformance. +*/ QModelingElement *QUmlProtocolConformance::clone() const { QUmlProtocolConformance *c = new QUmlProtocolConformance; @@ -79,6 +86,8 @@ QModelingElement *QUmlProtocolConformance::clone() const /*! Specifies the protocol state machine to which the specific state machine conforms. + + \b {Subsetted property(ies):} QUmlDirectedRelationship::targets(). */ QUmlProtocolStateMachine *QUmlProtocolConformance::generalMachine() const { @@ -87,6 +96,9 @@ QUmlProtocolStateMachine *QUmlProtocolConformance::generalMachine() const return _generalMachine; } +/*! + Adjusts generalMachine to \a generalMachine. + */ void QUmlProtocolConformance::setGeneralMachine(QUmlProtocolStateMachine *generalMachine) { // This is a read-write association end @@ -108,6 +120,10 @@ void QUmlProtocolConformance::setGeneralMachine(QUmlProtocolStateMachine *genera /*! Specifies the state machine which conforms to the general state machine. + + \b {Subsetted property(ies):} QUmlElement::owner(), QUmlDirectedRelationship::sources(). + + \b {Opposite property(ies):} QUmlProtocolStateMachine::conformance(). */ QUmlProtocolStateMachine *QUmlProtocolConformance::specificMachine() const { @@ -116,6 +132,9 @@ QUmlProtocolStateMachine *QUmlProtocolConformance::specificMachine() const return _specificMachine; } +/*! + Adjusts specificMachine to \a specificMachine. + */ void QUmlProtocolConformance::setSpecificMachine(QUmlProtocolStateMachine *specificMachine) { // This is a read-write association end diff --git a/src/uml/qumlprotocolconformance.h b/src/uml/qumlprotocolconformance.h index 56040046..be73de2b 100644 --- a/src/uml/qumlprotocolconformance.h +++ b/src/uml/qumlprotocolconformance.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlDirectedRelationship> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlProtocolConformance) *) -QT_END_HEADER - #endif // QUMLPROTOCOLCONFORMANCE_H diff --git a/src/uml/qumlprotocolstatemachine.cpp b/src/uml/qumlprotocolstatemachine.cpp index e066fe79..a4e1e7d6 100644 --- a/src/uml/qumlprotocolstatemachine.cpp +++ b/src/uml/qumlprotocolstatemachine.cpp @@ -96,6 +96,10 @@ QT_BEGIN_NAMESPACE \brief A protocol state machine is always defined in the context of a classifier. It specifies which operations of the classifier can be called in which state and under which condition, thus specifying the allowed call sequences on the classifier's operations. A protocol state machine presents the possible and permitted transitions on the instances of its context classifier, together with the operations which carry the transitions. In this manner, an instance lifecycle can be created for a classifier, by specifying the order in which the operations can be activated and the states through which an instance progresses during its existence. */ + +/*! + Creates a new QUmlProtocolStateMachine. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlProtocolStateMachine::QUmlProtocolStateMachine(bool createQModelingObject) : QUmlStateMachine(false) { @@ -103,6 +107,9 @@ QUmlProtocolStateMachine::QUmlProtocolStateMachine(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlProtocolStateMachineObject(this)); } +/*! + Returns a deep-copied clone of the QUmlProtocolStateMachine. +*/ QModelingElement *QUmlProtocolStateMachine::clone() const { QUmlProtocolStateMachine *c = new QUmlProtocolStateMachine; @@ -194,6 +201,12 @@ QModelingElement *QUmlProtocolStateMachine::clone() const /*! Conformance between protocol state machines. + + \sa addConformance(), removeConformance() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlProtocolConformance::specificMachine(). */ const QSet<QUmlProtocolConformance *> QUmlProtocolStateMachine::conformance() const { @@ -202,6 +215,11 @@ const QSet<QUmlProtocolConformance *> QUmlProtocolStateMachine::conformance() co return _conformance; } +/*! + Adds \a conformance to conformance. + + \sa conformance(), removeConformance() + */ void QUmlProtocolStateMachine::addConformance(QUmlProtocolConformance *conformance) { // This is a read-write association end @@ -222,6 +240,11 @@ void QUmlProtocolStateMachine::addConformance(QUmlProtocolConformance *conforman } } +/*! + Removes \a conformance from conformance. + + \sa conformance(), addConformance() + */ void QUmlProtocolStateMachine::removeConformance(QUmlProtocolConformance *conformance) { // This is a read-write association end diff --git a/src/uml/qumlprotocolstatemachine.h b/src/uml/qumlprotocolstatemachine.h index 7280d88a..3eff14a6 100644 --- a/src/uml/qumlprotocolstatemachine.h +++ b/src/uml/qumlprotocolstatemachine.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlStateMachine> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -73,7 +71,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlProtocolStateMachine) *) -QT_END_HEADER - #endif // QUMLPROTOCOLSTATEMACHINE_H diff --git a/src/uml/qumlprotocoltransition.cpp b/src/uml/qumlprotocoltransition.cpp index ece66589..ccb15eee 100644 --- a/src/uml/qumlprotocoltransition.cpp +++ b/src/uml/qumlprotocoltransition.cpp @@ -71,6 +71,10 @@ QT_BEGIN_NAMESPACE \brief A protocol transition specifies a legal transition for an operation. Transitions of protocol state machines have the following information: a pre condition (guard), on trigger, and a post condition. Every protocol transition is associated to zero or one operation (referred BehavioralFeature) that belongs to the context classifier of the protocol state machine. */ + +/*! + Creates a new QUmlProtocolTransition. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlProtocolTransition::QUmlProtocolTransition(bool createQModelingObject) : QUmlTransition(false), _postCondition(0), @@ -80,6 +84,9 @@ QUmlProtocolTransition::QUmlProtocolTransition(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlProtocolTransitionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlProtocolTransition. +*/ QModelingElement *QUmlProtocolTransition::clone() const { QUmlProtocolTransition *c = new QUmlProtocolTransition; @@ -124,6 +131,8 @@ QModelingElement *QUmlProtocolTransition::clone() const /*! Specifies the post condition of the transition which is the condition that should be obtained once the transition is triggered. This post condition is part of the post condition of the operation connected to the transition. + + \b {Subsetted property(ies):} QUmlNamespace::ownedRules(). */ QUmlConstraint *QUmlProtocolTransition::postCondition() const { @@ -132,6 +141,9 @@ QUmlConstraint *QUmlProtocolTransition::postCondition() const return _postCondition; } +/*! + Adjusts postCondition to \a postCondition. + */ void QUmlProtocolTransition::setPostCondition(QUmlConstraint *postCondition) { // This is a read-write association end @@ -154,6 +166,8 @@ void QUmlProtocolTransition::setPostCondition(QUmlConstraint *postCondition) /*! Specifies the precondition of the transition. It specifies the condition that should be verified before triggering the transition. This guard condition added to the source state will be evaluated as part of the precondition of the operation referred by the transition if any. + + \b {Subsetted property(ies):} QUmlTransition::guard(). */ QUmlConstraint *QUmlProtocolTransition::preCondition() const { @@ -162,6 +176,9 @@ QUmlConstraint *QUmlProtocolTransition::preCondition() const return _preCondition; } +/*! + Adjusts preCondition to \a preCondition. + */ void QUmlProtocolTransition::setPreCondition(QUmlConstraint *preCondition) { // This is a read-write association end @@ -181,6 +198,8 @@ void QUmlProtocolTransition::setPreCondition(QUmlConstraint *preCondition) /*! This association refers to the associated operation. It is derived from the operation of the call trigger when applicable. + + \b {This is a read-only derived property.} */ const QSet<QUmlOperation *> QUmlProtocolTransition::referred() const { @@ -191,6 +210,11 @@ const QSet<QUmlOperation *> QUmlProtocolTransition::referred() const return QSet<QUmlOperation *>(); } +/*! + Adds \a referred to referred. + + \sa referred(), removeReferred() + */ void QUmlProtocolTransition::addReferred(QUmlOperation *referred) { // This is a read-only derived association end @@ -203,6 +227,11 @@ void QUmlProtocolTransition::addReferred(QUmlOperation *referred) } } +/*! + Removes \a referred from referred. + + \sa referred(), addReferred() + */ void QUmlProtocolTransition::removeReferred(QUmlOperation *referred) { // This is a read-only derived association end diff --git a/src/uml/qumlprotocoltransition.h b/src/uml/qumlprotocoltransition.h index bf91f60f..ee729ba4 100644 --- a/src/uml/qumlprotocoltransition.h +++ b/src/uml/qumlprotocoltransition.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlTransition> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -79,7 +77,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlProtocolTransition) *) -QT_END_HEADER - #endif // QUMLPROTOCOLTRANSITION_H diff --git a/src/uml/qumlpseudostate.cpp b/src/uml/qumlpseudostate.cpp index 92ce2077..8017337b 100644 --- a/src/uml/qumlpseudostate.cpp +++ b/src/uml/qumlpseudostate.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief A pseudostate is an abstraction that encompasses different types of transient vertices in the state machine graph. */ + +/*! + Creates a new QUmlPseudostate. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlPseudostate::QUmlPseudostate(bool createQModelingObject) : _kind(QtUml::PseudostateKindInitial), _state(0), @@ -72,6 +76,9 @@ QUmlPseudostate::QUmlPseudostate(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlPseudostateObject(this)); } +/*! + Returns a deep-copied clone of the QUmlPseudostate. +*/ QModelingElement *QUmlPseudostate::clone() const { QUmlPseudostate *c = new QUmlPseudostate; @@ -105,6 +112,9 @@ QtUml::PseudostateKind QUmlPseudostate::kind() const return _kind; } +/*! + Adjusts kind to \a kind. + */ void QUmlPseudostate::setKind(QtUml::PseudostateKind kind) { // This is a read-write property @@ -117,6 +127,10 @@ void QUmlPseudostate::setKind(QtUml::PseudostateKind kind) /*! The State that owns this pseudostate and in which it appears. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlState::connectionPoints(). */ QUmlState *QUmlPseudostate::state() const { @@ -125,6 +139,9 @@ QUmlState *QUmlPseudostate::state() const return _state; } +/*! + Adjusts state to \a state. + */ void QUmlPseudostate::setState(QUmlState *state) { // This is a read-write association end @@ -143,6 +160,10 @@ void QUmlPseudostate::setState(QUmlState *state) /*! The StateMachine in which this Pseudostate is defined. This only applies to Pseudostates of the kind entryPoint or exitPoint. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlStateMachine::connectionPoints(). */ QUmlStateMachine *QUmlPseudostate::stateMachine() const { @@ -151,6 +172,9 @@ QUmlStateMachine *QUmlPseudostate::stateMachine() const return _stateMachine; } +/*! + Adjusts stateMachine to \a stateMachine. + */ void QUmlPseudostate::setStateMachine(QUmlStateMachine *stateMachine) { // This is a read-write association end diff --git a/src/uml/qumlpseudostate.h b/src/uml/qumlpseudostate.h index f49ddc06..6805bee9 100644 --- a/src/uml/qumlpseudostate.h +++ b/src/uml/qumlpseudostate.h @@ -47,8 +47,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlPseudostate) *) -QT_END_HEADER - #endif // QUMLPSEUDOSTATE_H diff --git a/src/uml/qumlqualifiervalue.cpp b/src/uml/qumlqualifiervalue.cpp index be0326bf..258d2837 100644 --- a/src/uml/qumlqualifiervalue.cpp +++ b/src/uml/qumlqualifiervalue.cpp @@ -55,6 +55,10 @@ QT_BEGIN_NAMESPACE \brief A qualifier value is not an action. It is an element that identifies links. It gives a single qualifier within a link end data specification. */ + +/*! + Creates a new QUmlQualifierValue. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlQualifierValue::QUmlQualifierValue(bool createQModelingObject) : _qualifier(0), _value(0) @@ -63,6 +67,9 @@ QUmlQualifierValue::QUmlQualifierValue(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlQualifierValueObject(this)); } +/*! + Returns a deep-copied clone of the QUmlQualifierValue. +*/ QModelingElement *QUmlQualifierValue::clone() const { QUmlQualifierValue *c = new QUmlQualifierValue; @@ -87,6 +94,9 @@ QUmlProperty *QUmlQualifierValue::qualifier() const return _qualifier; } +/*! + Adjusts qualifier to \a qualifier. + */ void QUmlQualifierValue::setQualifier(QUmlProperty *qualifier) { // This is a read-write association end @@ -108,6 +118,9 @@ QUmlInputPin *QUmlQualifierValue::value() const return _value; } +/*! + Adjusts value to \a value. + */ void QUmlQualifierValue::setValue(QUmlInputPin *value) { // This is a read-write association end diff --git a/src/uml/qumlqualifiervalue.h b/src/uml/qumlqualifiervalue.h index 3d1c94ce..20e3bf16 100644 --- a/src/uml/qumlqualifiervalue.h +++ b/src/uml/qumlqualifiervalue.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlQualifierValue) *) -QT_END_HEADER - #endif // QUMLQUALIFIERVALUE_H diff --git a/src/uml/qumlraiseexceptionaction.cpp b/src/uml/qumlraiseexceptionaction.cpp index e2463a86..838d31ca 100644 --- a/src/uml/qumlraiseexceptionaction.cpp +++ b/src/uml/qumlraiseexceptionaction.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief A raise exception action is an action that causes an exception to occur. The input value becomes the exception object. */ + +/*! + Creates a new QUmlRaiseExceptionAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlRaiseExceptionAction::QUmlRaiseExceptionAction(bool createQModelingObject) : _exception(0) { @@ -79,6 +83,9 @@ QUmlRaiseExceptionAction::QUmlRaiseExceptionAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlRaiseExceptionActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlRaiseExceptionAction. +*/ QModelingElement *QUmlRaiseExceptionAction::clone() const { QUmlRaiseExceptionAction *c = new QUmlRaiseExceptionAction; @@ -121,6 +128,8 @@ QModelingElement *QUmlRaiseExceptionAction::clone() const /*! An input pin whose value becomes an exception object. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlRaiseExceptionAction::exception() const { @@ -129,6 +138,9 @@ QUmlInputPin *QUmlRaiseExceptionAction::exception() const return _exception; } +/*! + Adjusts exception to \a exception. + */ void QUmlRaiseExceptionAction::setException(QUmlInputPin *exception) { // This is a read-write association end diff --git a/src/uml/qumlraiseexceptionaction.h b/src/uml/qumlraiseexceptionaction.h index 463fd390..7a808ec4 100644 --- a/src/uml/qumlraiseexceptionaction.h +++ b/src/uml/qumlraiseexceptionaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlRaiseExceptionAction) *) -QT_END_HEADER - #endif // QUMLRAISEEXCEPTIONACTION_H diff --git a/src/uml/qumlreadextentaction.cpp b/src/uml/qumlreadextentaction.cpp index eb24c6ea..4fb6114d 100644 --- a/src/uml/qumlreadextentaction.cpp +++ b/src/uml/qumlreadextentaction.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief A read extent action is an action that retrieves the current instances of a classifier. */ + +/*! + Creates a new QUmlReadExtentAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReadExtentAction::QUmlReadExtentAction(bool createQModelingObject) : _classifier(0), _result(0) @@ -80,6 +84,9 @@ QUmlReadExtentAction::QUmlReadExtentAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReadExtentActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReadExtentAction. +*/ QModelingElement *QUmlReadExtentAction::clone() const { QUmlReadExtentAction *c = new QUmlReadExtentAction; @@ -132,6 +139,9 @@ QUmlClassifier *QUmlReadExtentAction::classifier() const return _classifier; } +/*! + Adjusts classifier to \a classifier. + */ void QUmlReadExtentAction::setClassifier(QUmlClassifier *classifier) { // This is a read-write association end @@ -145,6 +155,8 @@ void QUmlReadExtentAction::setClassifier(QUmlClassifier *classifier) /*! The runtime instances of the classifier. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlReadExtentAction::result() const { @@ -153,6 +165,9 @@ QUmlOutputPin *QUmlReadExtentAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlReadExtentAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlreadextentaction.h b/src/uml/qumlreadextentaction.h index df805fe4..bf273eb1 100644 --- a/src/uml/qumlreadextentaction.h +++ b/src/uml/qumlreadextentaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReadExtentAction) *) -QT_END_HEADER - #endif // QUMLREADEXTENTACTION_H diff --git a/src/uml/qumlreadisclassifiedobjectaction.cpp b/src/uml/qumlreadisclassifiedobjectaction.cpp index 4d8260af..3e873d1a 100644 --- a/src/uml/qumlreadisclassifiedobjectaction.cpp +++ b/src/uml/qumlreadisclassifiedobjectaction.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief A read is classified object action is an action that determines whether a runtime object is classified by a given classifier. */ + +/*! + Creates a new QUmlReadIsClassifiedObjectAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReadIsClassifiedObjectAction::QUmlReadIsClassifiedObjectAction(bool createQModelingObject) : _classifier(0), _isDirect(false), @@ -82,6 +86,9 @@ QUmlReadIsClassifiedObjectAction::QUmlReadIsClassifiedObjectAction(bool createQM _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReadIsClassifiedObjectActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReadIsClassifiedObjectAction. +*/ QModelingElement *QUmlReadIsClassifiedObjectAction::clone() const { QUmlReadIsClassifiedObjectAction *c = new QUmlReadIsClassifiedObjectAction; @@ -137,6 +144,9 @@ QUmlClassifier *QUmlReadIsClassifiedObjectAction::classifier() const return _classifier; } +/*! + Adjusts classifier to \a classifier. + */ void QUmlReadIsClassifiedObjectAction::setClassifier(QUmlClassifier *classifier) { // This is a read-write association end @@ -158,6 +168,9 @@ bool QUmlReadIsClassifiedObjectAction::isDirect() const return _isDirect; } +/*! + Adjusts isDirect to \a isDirect. + */ void QUmlReadIsClassifiedObjectAction::setDirect(bool isDirect) { // This is a read-write property @@ -170,6 +183,8 @@ void QUmlReadIsClassifiedObjectAction::setDirect(bool isDirect) /*! Holds the object whose classification is to be tested. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlReadIsClassifiedObjectAction::object() const { @@ -178,6 +193,9 @@ QUmlInputPin *QUmlReadIsClassifiedObjectAction::object() const return _object; } +/*! + Adjusts object to \a object. + */ void QUmlReadIsClassifiedObjectAction::setObject(QUmlInputPin *object) { // This is a read-write association end @@ -200,6 +218,8 @@ void QUmlReadIsClassifiedObjectAction::setObject(QUmlInputPin *object) /*! After termination of the action, will hold the result of the test. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlReadIsClassifiedObjectAction::result() const { @@ -208,6 +228,9 @@ QUmlOutputPin *QUmlReadIsClassifiedObjectAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlReadIsClassifiedObjectAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlreadisclassifiedobjectaction.h b/src/uml/qumlreadisclassifiedobjectaction.h index b5bd0fd0..05891b6f 100644 --- a/src/uml/qumlreadisclassifiedobjectaction.h +++ b/src/uml/qumlreadisclassifiedobjectaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -83,7 +81,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReadIsClassifiedObjectAction) *) -QT_END_HEADER - #endif // QUMLREADISCLASSIFIEDOBJECTACTION_H diff --git a/src/uml/qumlreadlinkaction.cpp b/src/uml/qumlreadlinkaction.cpp index 9c94a99b..ac12ae77 100644 --- a/src/uml/qumlreadlinkaction.cpp +++ b/src/uml/qumlreadlinkaction.cpp @@ -74,6 +74,10 @@ QT_BEGIN_NAMESPACE \brief A read link action is a link action that navigates across associations to retrieve objects on one end. */ + +/*! + Creates a new QUmlReadLinkAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReadLinkAction::QUmlReadLinkAction(bool createQModelingObject) : _result(0) { @@ -81,6 +85,9 @@ QUmlReadLinkAction::QUmlReadLinkAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReadLinkActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReadLinkAction. +*/ QModelingElement *QUmlReadLinkAction::clone() const { QUmlReadLinkAction *c = new QUmlReadLinkAction; @@ -127,6 +134,8 @@ QModelingElement *QUmlReadLinkAction::clone() const /*! The pin on which are put the objects participating in the association at the end not specified by the inputs. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlReadLinkAction::result() const { @@ -135,6 +144,9 @@ QUmlOutputPin *QUmlReadLinkAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlReadLinkAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlreadlinkaction.h b/src/uml/qumlreadlinkaction.h index 670495fc..6c110573 100644 --- a/src/uml/qumlreadlinkaction.h +++ b/src/uml/qumlreadlinkaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlLinkAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReadLinkAction) *) -QT_END_HEADER - #endif // QUMLREADLINKACTION_H diff --git a/src/uml/qumlreadlinkobjectendaction.cpp b/src/uml/qumlreadlinkobjectendaction.cpp index b4f6ddd5..20670c42 100644 --- a/src/uml/qumlreadlinkobjectendaction.cpp +++ b/src/uml/qumlreadlinkobjectendaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A read link object end action is an action that retrieves an end object from a link object. */ + +/*! + Creates a new QUmlReadLinkObjectEndAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReadLinkObjectEndAction::QUmlReadLinkObjectEndAction(bool createQModelingObject) : _end(0), _object(0), @@ -82,6 +86,9 @@ QUmlReadLinkObjectEndAction::QUmlReadLinkObjectEndAction(bool createQModelingObj _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReadLinkObjectEndActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReadLinkObjectEndAction. +*/ QModelingElement *QUmlReadLinkObjectEndAction::clone() const { QUmlReadLinkObjectEndAction *c = new QUmlReadLinkObjectEndAction; @@ -136,6 +143,9 @@ QUmlProperty *QUmlReadLinkObjectEndAction::end() const return _end; } +/*! + Adjusts end to \a end. + */ void QUmlReadLinkObjectEndAction::setEnd(QUmlProperty *end) { // This is a read-write association end @@ -149,6 +159,8 @@ void QUmlReadLinkObjectEndAction::setEnd(QUmlProperty *end) /*! Gives the input pin from which the link object is obtained. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlReadLinkObjectEndAction::object() const { @@ -157,6 +169,9 @@ QUmlInputPin *QUmlReadLinkObjectEndAction::object() const return _object; } +/*! + Adjusts object to \a object. + */ void QUmlReadLinkObjectEndAction::setObject(QUmlInputPin *object) { // This is a read-write association end @@ -179,6 +194,8 @@ void QUmlReadLinkObjectEndAction::setObject(QUmlInputPin *object) /*! Pin where the result value is placed. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlReadLinkObjectEndAction::result() const { @@ -187,6 +204,9 @@ QUmlOutputPin *QUmlReadLinkObjectEndAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlReadLinkObjectEndAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlreadlinkobjectendaction.h b/src/uml/qumlreadlinkobjectendaction.h index e1770f4f..fd56520c 100644 --- a/src/uml/qumlreadlinkobjectendaction.h +++ b/src/uml/qumlreadlinkobjectendaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -80,7 +78,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReadLinkObjectEndAction) *) -QT_END_HEADER - #endif // QUMLREADLINKOBJECTENDACTION_H diff --git a/src/uml/qumlreadlinkobjectendqualifieraction.cpp b/src/uml/qumlreadlinkobjectendqualifieraction.cpp index ddbacc32..145aa9db 100644 --- a/src/uml/qumlreadlinkobjectendqualifieraction.cpp +++ b/src/uml/qumlreadlinkobjectendqualifieraction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A read link object end qualifier action is an action that retrieves a qualifier end value from a link object. */ + +/*! + Creates a new QUmlReadLinkObjectEndQualifierAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReadLinkObjectEndQualifierAction::QUmlReadLinkObjectEndQualifierAction(bool createQModelingObject) : _object(0), _qualifier(0), @@ -82,6 +86,9 @@ QUmlReadLinkObjectEndQualifierAction::QUmlReadLinkObjectEndQualifierAction(bool _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReadLinkObjectEndQualifierActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReadLinkObjectEndQualifierAction. +*/ QModelingElement *QUmlReadLinkObjectEndQualifierAction::clone() const { QUmlReadLinkObjectEndQualifierAction *c = new QUmlReadLinkObjectEndQualifierAction; @@ -128,6 +135,8 @@ QModelingElement *QUmlReadLinkObjectEndQualifierAction::clone() const /*! Gives the input pin from which the link object is obtained. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlReadLinkObjectEndQualifierAction::object() const { @@ -136,6 +145,9 @@ QUmlInputPin *QUmlReadLinkObjectEndQualifierAction::object() const return _object; } +/*! + Adjusts object to \a object. + */ void QUmlReadLinkObjectEndQualifierAction::setObject(QUmlInputPin *object) { // This is a read-write association end @@ -166,6 +178,9 @@ QUmlProperty *QUmlReadLinkObjectEndQualifierAction::qualifier() const return _qualifier; } +/*! + Adjusts qualifier to \a qualifier. + */ void QUmlReadLinkObjectEndQualifierAction::setQualifier(QUmlProperty *qualifier) { // This is a read-write association end @@ -179,6 +194,8 @@ void QUmlReadLinkObjectEndQualifierAction::setQualifier(QUmlProperty *qualifier) /*! Pin where the result value is placed. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlReadLinkObjectEndQualifierAction::result() const { @@ -187,6 +204,9 @@ QUmlOutputPin *QUmlReadLinkObjectEndQualifierAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlReadLinkObjectEndQualifierAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlreadlinkobjectendqualifieraction.h b/src/uml/qumlreadlinkobjectendqualifieraction.h index 870b6727..9d6144e0 100644 --- a/src/uml/qumlreadlinkobjectendqualifieraction.h +++ b/src/uml/qumlreadlinkobjectendqualifieraction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -80,7 +78,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReadLinkObjectEndQualifierAction) *) -QT_END_HEADER - #endif // QUMLREADLINKOBJECTENDQUALIFIERACTION_H diff --git a/src/uml/qumlreadselfaction.cpp b/src/uml/qumlreadselfaction.cpp index 6e60f14e..ddf9c10c 100644 --- a/src/uml/qumlreadselfaction.cpp +++ b/src/uml/qumlreadselfaction.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief A read self action is an action that retrieves the host object of an action. */ + +/*! + Creates a new QUmlReadSelfAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReadSelfAction::QUmlReadSelfAction(bool createQModelingObject) : _result(0) { @@ -79,6 +83,9 @@ QUmlReadSelfAction::QUmlReadSelfAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReadSelfActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReadSelfAction. +*/ QModelingElement *QUmlReadSelfAction::clone() const { QUmlReadSelfAction *c = new QUmlReadSelfAction; @@ -121,6 +128,8 @@ QModelingElement *QUmlReadSelfAction::clone() const /*! Gives the output pin on which the hosting object is placed. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlReadSelfAction::result() const { @@ -129,6 +138,9 @@ QUmlOutputPin *QUmlReadSelfAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlReadSelfAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlreadselfaction.h b/src/uml/qumlreadselfaction.h index 639b2dfb..9211b6fe 100644 --- a/src/uml/qumlreadselfaction.h +++ b/src/uml/qumlreadselfaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReadSelfAction) *) -QT_END_HEADER - #endif // QUMLREADSELFACTION_H diff --git a/src/uml/qumlreadstructuralfeatureaction.cpp b/src/uml/qumlreadstructuralfeatureaction.cpp index 95f8ba27..60e22683 100644 --- a/src/uml/qumlreadstructuralfeatureaction.cpp +++ b/src/uml/qumlreadstructuralfeatureaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A read structural feature action is a structural feature action that retrieves the values of a structural feature. */ + +/*! + Creates a new QUmlReadStructuralFeatureAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReadStructuralFeatureAction::QUmlReadStructuralFeatureAction(bool createQModelingObject) : _result(0) { @@ -80,6 +84,9 @@ QUmlReadStructuralFeatureAction::QUmlReadStructuralFeatureAction(bool createQMod _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReadStructuralFeatureActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReadStructuralFeatureAction. +*/ QModelingElement *QUmlReadStructuralFeatureAction::clone() const { QUmlReadStructuralFeatureAction *c = new QUmlReadStructuralFeatureAction; @@ -126,6 +133,8 @@ QModelingElement *QUmlReadStructuralFeatureAction::clone() const /*! Gives the output pin on which the result is put. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlReadStructuralFeatureAction::result() const { @@ -134,6 +143,9 @@ QUmlOutputPin *QUmlReadStructuralFeatureAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlReadStructuralFeatureAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlreadstructuralfeatureaction.h b/src/uml/qumlreadstructuralfeatureaction.h index 277516d6..1b593608 100644 --- a/src/uml/qumlreadstructuralfeatureaction.h +++ b/src/uml/qumlreadstructuralfeatureaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlStructuralFeatureAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReadStructuralFeatureAction) *) -QT_END_HEADER - #endif // QUMLREADSTRUCTURALFEATUREACTION_H diff --git a/src/uml/qumlreadvariableaction.cpp b/src/uml/qumlreadvariableaction.cpp index 41ecdffc..be333b72 100644 --- a/src/uml/qumlreadvariableaction.cpp +++ b/src/uml/qumlreadvariableaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A read variable action is a variable action that retrieves the values of a variable. */ + +/*! + Creates a new QUmlReadVariableAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReadVariableAction::QUmlReadVariableAction(bool createQModelingObject) : _result(0) { @@ -80,6 +84,9 @@ QUmlReadVariableAction::QUmlReadVariableAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReadVariableActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReadVariableAction. +*/ QModelingElement *QUmlReadVariableAction::clone() const { QUmlReadVariableAction *c = new QUmlReadVariableAction; @@ -124,6 +131,8 @@ QModelingElement *QUmlReadVariableAction::clone() const /*! Gives the output pin on which the result is put. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlReadVariableAction::result() const { @@ -132,6 +141,9 @@ QUmlOutputPin *QUmlReadVariableAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlReadVariableAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlreadvariableaction.h b/src/uml/qumlreadvariableaction.h index 420850bc..3baaeb3b 100644 --- a/src/uml/qumlreadvariableaction.h +++ b/src/uml/qumlreadvariableaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlVariableAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReadVariableAction) *) -QT_END_HEADER - #endif // QUMLREADVARIABLEACTION_H diff --git a/src/uml/qumlrealization.cpp b/src/uml/qumlrealization.cpp index f4ae3556..bf6e157d 100644 --- a/src/uml/qumlrealization.cpp +++ b/src/uml/qumlrealization.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief Realization is a specialized abstraction relationship between two sets of model elements, one representing a specification (the supplier) and the other represents an implementation of the latter (the client). Realization can be used to model stepwise refinement, optimizations, transformations, templates, model synthesis, framework composition, etc. */ + +/*! + Creates a new QUmlRealization. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlRealization::QUmlRealization(bool createQModelingObject) : QUmlAbstraction(false) { @@ -69,6 +73,9 @@ QUmlRealization::QUmlRealization(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlRealizationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlRealization. +*/ QModelingElement *QUmlRealization::clone() const { QUmlRealization *c = new QUmlRealization; diff --git a/src/uml/qumlrealization.h b/src/uml/qumlrealization.h index 1c60f438..885e1152 100644 --- a/src/uml/qumlrealization.h +++ b/src/uml/qumlrealization.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAbstraction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlRealization) *) -QT_END_HEADER - #endif // QUMLREALIZATION_H diff --git a/src/uml/qumlreception.cpp b/src/uml/qumlreception.cpp index 56949531..1b32ac68 100644 --- a/src/uml/qumlreception.cpp +++ b/src/uml/qumlreception.cpp @@ -70,6 +70,10 @@ QT_BEGIN_NAMESPACE \brief A reception is a declaration stating that a classifier is prepared to react to the receipt of a signal. A reception designates a signal and specifies the expected behavioral response. The details of handling a signal are specified by the behavior associated with the reception or the classifier itself. */ + +/*! + Creates a new QUmlReception. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReception::QUmlReception(bool createQModelingObject) : _signal(0) { @@ -77,6 +81,9 @@ QUmlReception::QUmlReception(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReceptionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReception. +*/ QModelingElement *QUmlReception::clone() const { QUmlReception *c = new QUmlReception; @@ -123,6 +130,9 @@ QUmlSignal *QUmlReception::signal() const return _signal; } +/*! + Adjusts signal to \a signal. + */ void QUmlReception::setSignal(QUmlSignal *signal) { // This is a read-write association end diff --git a/src/uml/qumlreception.h b/src/uml/qumlreception.h index 0cdded21..f2362bb7 100644 --- a/src/uml/qumlreception.h +++ b/src/uml/qumlreception.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlBehavioralFeature> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReception) *) -QT_END_HEADER - #endif // QUMLRECEPTION_H diff --git a/src/uml/qumlreclassifyobjectaction.cpp b/src/uml/qumlreclassifyobjectaction.cpp index 8485fe31..745e43f3 100644 --- a/src/uml/qumlreclassifyobjectaction.cpp +++ b/src/uml/qumlreclassifyobjectaction.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief A reclassify object action is an action that changes which classifiers classify an object. */ + +/*! + Creates a new QUmlReclassifyObjectAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReclassifyObjectAction::QUmlReclassifyObjectAction(bool createQModelingObject) : _isReplaceAll(false), _object(0) @@ -80,6 +84,9 @@ QUmlReclassifyObjectAction::QUmlReclassifyObjectAction(bool createQModelingObjec _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReclassifyObjectActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReclassifyObjectAction. +*/ QModelingElement *QUmlReclassifyObjectAction::clone() const { QUmlReclassifyObjectAction *c = new QUmlReclassifyObjectAction; @@ -135,6 +142,9 @@ bool QUmlReclassifyObjectAction::isReplaceAll() const return _isReplaceAll; } +/*! + Adjusts isReplaceAll to \a isReplaceAll. + */ void QUmlReclassifyObjectAction::setReplaceAll(bool isReplaceAll) { // This is a read-write property @@ -147,6 +157,8 @@ void QUmlReclassifyObjectAction::setReplaceAll(bool isReplaceAll) /*! A set of classifiers to be added to the classifiers of the object. + + \sa addNewClassifier(), removeNewClassifier() */ const QSet<QUmlClassifier *> QUmlReclassifyObjectAction::newClassifiers() const { @@ -155,6 +167,11 @@ const QSet<QUmlClassifier *> QUmlReclassifyObjectAction::newClassifiers() const return _newClassifiers; } +/*! + Adds \a newClassifier to newClassifiers. + + \sa newClassifiers(), removeNewClassifier() + */ void QUmlReclassifyObjectAction::addNewClassifier(QUmlClassifier *newClassifier) { // This is a read-write association end @@ -166,6 +183,11 @@ void QUmlReclassifyObjectAction::addNewClassifier(QUmlClassifier *newClassifier) } } +/*! + Removes \a newClassifier from newClassifiers. + + \sa newClassifiers(), addNewClassifier() + */ void QUmlReclassifyObjectAction::removeNewClassifier(QUmlClassifier *newClassifier) { // This is a read-write association end @@ -177,6 +199,8 @@ void QUmlReclassifyObjectAction::removeNewClassifier(QUmlClassifier *newClassifi /*! Holds the object to be reclassified. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlReclassifyObjectAction::object() const { @@ -185,6 +209,9 @@ QUmlInputPin *QUmlReclassifyObjectAction::object() const return _object; } +/*! + Adjusts object to \a object. + */ void QUmlReclassifyObjectAction::setObject(QUmlInputPin *object) { // This is a read-write association end @@ -207,6 +234,8 @@ void QUmlReclassifyObjectAction::setObject(QUmlInputPin *object) /*! A set of classifiers to be removed from the classifiers of the object. + + \sa addOldClassifier(), removeOldClassifier() */ const QSet<QUmlClassifier *> QUmlReclassifyObjectAction::oldClassifiers() const { @@ -215,6 +244,11 @@ const QSet<QUmlClassifier *> QUmlReclassifyObjectAction::oldClassifiers() const return _oldClassifiers; } +/*! + Adds \a oldClassifier to oldClassifiers. + + \sa oldClassifiers(), removeOldClassifier() + */ void QUmlReclassifyObjectAction::addOldClassifier(QUmlClassifier *oldClassifier) { // This is a read-write association end @@ -226,6 +260,11 @@ void QUmlReclassifyObjectAction::addOldClassifier(QUmlClassifier *oldClassifier) } } +/*! + Removes \a oldClassifier from oldClassifiers. + + \sa oldClassifiers(), addOldClassifier() + */ void QUmlReclassifyObjectAction::removeOldClassifier(QUmlClassifier *oldClassifier) { // This is a read-write association end diff --git a/src/uml/qumlreclassifyobjectaction.h b/src/uml/qumlreclassifyobjectaction.h index 32ababd9..8b201140 100644 --- a/src/uml/qumlreclassifyobjectaction.h +++ b/src/uml/qumlreclassifyobjectaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -84,7 +82,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReclassifyObjectAction) *) -QT_END_HEADER - #endif // QUMLRECLASSIFYOBJECTACTION_H diff --git a/src/uml/qumlredefinableelement.cpp b/src/uml/qumlredefinableelement.cpp index beab1055..e958ea74 100644 --- a/src/uml/qumlredefinableelement.cpp +++ b/src/uml/qumlredefinableelement.cpp @@ -56,12 +56,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A redefinable element is an element that, when defined in the context of a classifier, can be redefined more specifically or differently in the context of another classifier that specializes (directly or indirectly) the context classifier. + + \b {QUmlRedefinableElement is an abstract class.} */ + +/*! + Creates a new QUmlRedefinableElement. +*/ QUmlRedefinableElement::QUmlRedefinableElement() : _isLeaf(false) { } +/*! + Returns a deep-copied clone of the QUmlRedefinableElement. +*/ QModelingElement *QUmlRedefinableElement::clone() const { QUmlRedefinableElement *c = new QUmlRedefinableElement; @@ -89,6 +98,9 @@ bool QUmlRedefinableElement::isLeaf() const return _isLeaf; } +/*! + Adjusts isLeaf to \a isLeaf. + */ void QUmlRedefinableElement::setLeaf(bool isLeaf) { // This is a read-write property @@ -101,6 +113,8 @@ void QUmlRedefinableElement::setLeaf(bool isLeaf) /*! The redefinable element that is being redefined by this element. + + \b {This is a read-only derived union property.} */ const QSet<QUmlRedefinableElement *> QUmlRedefinableElement::redefinedElements() const { @@ -109,6 +123,11 @@ const QSet<QUmlRedefinableElement *> QUmlRedefinableElement::redefinedElements() return _redefinedElements; } +/*! + Adds \a redefinedElement to redefinedElements. + + \sa redefinedElements(), removeRedefinedElement() + */ void QUmlRedefinableElement::addRedefinedElement(QUmlRedefinableElement *redefinedElement) { // This is a read-only derived union association end @@ -120,6 +139,11 @@ void QUmlRedefinableElement::addRedefinedElement(QUmlRedefinableElement *redefin } } +/*! + Removes \a redefinedElement from redefinedElements. + + \sa redefinedElements(), addRedefinedElement() + */ void QUmlRedefinableElement::removeRedefinedElement(QUmlRedefinableElement *redefinedElement) { // This is a read-only derived union association end @@ -131,6 +155,8 @@ void QUmlRedefinableElement::removeRedefinedElement(QUmlRedefinableElement *rede /*! References the contexts that this element may be redefined from. + + \b {This is a read-only derived union property.} */ const QSet<QUmlClassifier *> QUmlRedefinableElement::redefinitionContexts() const { @@ -139,6 +165,11 @@ const QSet<QUmlClassifier *> QUmlRedefinableElement::redefinitionContexts() cons return _redefinitionContexts; } +/*! + Adds \a redefinitionContext to redefinitionContexts. + + \sa redefinitionContexts(), removeRedefinitionContext() + */ void QUmlRedefinableElement::addRedefinitionContext(QUmlClassifier *redefinitionContext) { // This is a read-only derived union association end @@ -150,6 +181,11 @@ void QUmlRedefinableElement::addRedefinitionContext(QUmlClassifier *redefinition } } +/*! + Removes \a redefinitionContext from redefinitionContexts. + + \sa redefinitionContexts(), addRedefinitionContext() + */ void QUmlRedefinableElement::removeRedefinitionContext(QUmlClassifier *redefinitionContext) { // This is a read-only derived union association end diff --git a/src/uml/qumlredefinableelement.h b/src/uml/qumlredefinableelement.h index 66619212..bc7dac0b 100644 --- a/src/uml/qumlredefinableelement.h +++ b/src/uml/qumlredefinableelement.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -84,7 +82,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlRedefinableElement) *) -QT_END_HEADER - #endif // QUMLREDEFINABLEELEMENT_H diff --git a/src/uml/qumlredefinabletemplatesignature.cpp b/src/uml/qumlredefinabletemplatesignature.cpp index e59930d8..5d5e8b63 100644 --- a/src/uml/qumlredefinabletemplatesignature.cpp +++ b/src/uml/qumlredefinabletemplatesignature.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief A redefinable template signature supports the addition of formal template parameters in a specialization of a template classifier. */ + +/*! + Creates a new QUmlRedefinableTemplateSignature. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlRedefinableTemplateSignature::QUmlRedefinableTemplateSignature(bool createQModelingObject) : QUmlTemplateSignature(false), _classifier(0) @@ -70,6 +74,9 @@ QUmlRedefinableTemplateSignature::QUmlRedefinableTemplateSignature(bool createQM _qModelingObject = qobject_cast<QModelingObject *>(new QUmlRedefinableTemplateSignatureObject(this)); } +/*! + Returns a deep-copied clone of the QUmlRedefinableTemplateSignature. +*/ QModelingElement *QUmlRedefinableTemplateSignature::clone() const { QUmlRedefinableTemplateSignature *c = new QUmlRedefinableTemplateSignature; @@ -99,6 +106,12 @@ QModelingElement *QUmlRedefinableTemplateSignature::clone() const /*! The classifier that owns this template signature. + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinitionContexts(). + + \b {Redefined property(ies):} QUmlTemplateSignature::template_(). + + \b {Opposite property(ies):} QUmlClassifier::ownedTemplateSignature(). */ QUmlClassifier *QUmlRedefinableTemplateSignature::classifier() const { @@ -107,6 +120,9 @@ QUmlClassifier *QUmlRedefinableTemplateSignature::classifier() const return _classifier; } +/*! + Adjusts classifier to \a classifier. + */ void QUmlRedefinableTemplateSignature::setClassifier(QUmlClassifier *classifier) { // This is a read-write association end @@ -131,6 +147,10 @@ void QUmlRedefinableTemplateSignature::setClassifier(QUmlClassifier *classifier) /*! The template signature that is extended by this template signature. + + \sa addExtendedSignature(), removeExtendedSignature() + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinedElements(). */ const QSet<QUmlRedefinableTemplateSignature *> QUmlRedefinableTemplateSignature::extendedSignatures() const { @@ -139,6 +159,11 @@ const QSet<QUmlRedefinableTemplateSignature *> QUmlRedefinableTemplateSignature: return _extendedSignatures; } +/*! + Adds \a extendedSignature to extendedSignatures. + + \sa extendedSignatures(), removeExtendedSignature() + */ void QUmlRedefinableTemplateSignature::addExtendedSignature(QUmlRedefinableTemplateSignature *extendedSignature) { // This is a read-write association end @@ -153,6 +178,11 @@ void QUmlRedefinableTemplateSignature::addExtendedSignature(QUmlRedefinableTempl } } +/*! + Removes \a extendedSignature from extendedSignatures. + + \sa extendedSignatures(), addExtendedSignature() + */ void QUmlRedefinableTemplateSignature::removeExtendedSignature(QUmlRedefinableTemplateSignature *extendedSignature) { // This is a read-write association end @@ -167,6 +197,10 @@ void QUmlRedefinableTemplateSignature::removeExtendedSignature(QUmlRedefinableTe /*! The formal template parameters of the extendedSignature. + + \b {This is a read-only derived property.} + + \b {Subsetted property(ies):} QUmlTemplateSignature::parameters(). */ const QSet<QUmlTemplateParameter *> QUmlRedefinableTemplateSignature::inheritedParameters() const { @@ -177,6 +211,11 @@ const QSet<QUmlTemplateParameter *> QUmlRedefinableTemplateSignature::inheritedP return QSet<QUmlTemplateParameter *>(); } +/*! + Adds \a inheritedParameter to inheritedParameters. + + \sa inheritedParameters(), removeInheritedParameter() + */ void QUmlRedefinableTemplateSignature::addInheritedParameter(QUmlTemplateParameter *inheritedParameter) { // This is a read-only derived association end @@ -192,6 +231,11 @@ void QUmlRedefinableTemplateSignature::addInheritedParameter(QUmlTemplateParamet } } +/*! + Removes \a inheritedParameter from inheritedParameters. + + \sa inheritedParameters(), addInheritedParameter() + */ void QUmlRedefinableTemplateSignature::removeInheritedParameter(QUmlTemplateParameter *inheritedParameter) { // This is a read-only derived association end diff --git a/src/uml/qumlredefinabletemplatesignature.h b/src/uml/qumlredefinabletemplatesignature.h index 37f12b55..f406deb8 100644 --- a/src/uml/qumlredefinabletemplatesignature.h +++ b/src/uml/qumlredefinabletemplatesignature.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlTemplateSignature> #include <QtUml/QUmlRedefinableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -84,7 +82,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlRedefinableTemplateSignature) *) -QT_END_HEADER - #endif // QUMLREDEFINABLETEMPLATESIGNATURE_H diff --git a/src/uml/qumlreduceaction.cpp b/src/uml/qumlreduceaction.cpp index 3ad83d8a..0f037794 100644 --- a/src/uml/qumlreduceaction.cpp +++ b/src/uml/qumlreduceaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A reduce action is an action that reduces a collection to a single value by combining the elements of the collection. */ + +/*! + Creates a new QUmlReduceAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReduceAction::QUmlReduceAction(bool createQModelingObject) : _collection(0), _isOrdered(false), @@ -83,6 +87,9 @@ QUmlReduceAction::QUmlReduceAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReduceActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReduceAction. +*/ QModelingElement *QUmlReduceAction::clone() const { QUmlReduceAction *c = new QUmlReduceAction; @@ -130,6 +137,8 @@ QModelingElement *QUmlReduceAction::clone() const /*! The collection to be reduced. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlReduceAction::collection() const { @@ -138,6 +147,9 @@ QUmlInputPin *QUmlReduceAction::collection() const return _collection; } +/*! + Adjusts collection to \a collection. + */ void QUmlReduceAction::setCollection(QUmlInputPin *collection) { // This is a read-write association end @@ -168,6 +180,9 @@ bool QUmlReduceAction::isOrdered() const return _isOrdered; } +/*! + Adjusts isOrdered to \a isOrdered. + */ void QUmlReduceAction::setOrdered(bool isOrdered) { // This is a read-write property @@ -188,6 +203,9 @@ QUmlBehavior *QUmlReduceAction::reducer() const return _reducer; } +/*! + Adjusts reducer to \a reducer. + */ void QUmlReduceAction::setReducer(QUmlBehavior *reducer) { // This is a read-write association end @@ -201,6 +219,8 @@ void QUmlReduceAction::setReducer(QUmlBehavior *reducer) /*! Gives the output pin on which the result is put. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlReduceAction::result() const { @@ -209,6 +229,9 @@ QUmlOutputPin *QUmlReduceAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlReduceAction::setResult(QUmlOutputPin *result) { // This is a read-write association end diff --git a/src/uml/qumlreduceaction.h b/src/uml/qumlreduceaction.h index 6ff82fb1..6386f80f 100644 --- a/src/uml/qumlreduceaction.h +++ b/src/uml/qumlreduceaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -83,7 +81,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReduceAction) *) -QT_END_HEADER - #endif // QUMLREDUCEACTION_H diff --git a/src/uml/qumlregion.cpp b/src/uml/qumlregion.cpp index 6272f088..ada846ef 100644 --- a/src/uml/qumlregion.cpp +++ b/src/uml/qumlregion.cpp @@ -67,6 +67,10 @@ QT_BEGIN_NAMESPACE \brief A region is an orthogonal part of either a composite state or a state machine. It contains states and transitions. */ + +/*! + Creates a new QUmlRegion. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlRegion::QUmlRegion(bool createQModelingObject) : _extendedRegion(0), _state(0), @@ -76,6 +80,9 @@ QUmlRegion::QUmlRegion(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlRegionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlRegion. +*/ QModelingElement *QUmlRegion::clone() const { QUmlRegion *c = new QUmlRegion; @@ -111,6 +118,8 @@ QModelingElement *QUmlRegion::clone() const /*! The region of which this region is an extension. + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinedElements(). */ QUmlRegion *QUmlRegion::extendedRegion() const { @@ -119,6 +128,9 @@ QUmlRegion *QUmlRegion::extendedRegion() const return _extendedRegion; } +/*! + Adjusts extendedRegion to \a extendedRegion. + */ void QUmlRegion::setExtendedRegion(QUmlRegion *extendedRegion) { // This is a read-write association end @@ -140,6 +152,10 @@ void QUmlRegion::setExtendedRegion(QUmlRegion *extendedRegion) /*! References the classifier in which context this element may be redefined. + + \b {This is a read-only derived property.} + + \b {Redefined property(ies):} QUmlRedefinableElement::redefinitionContexts(). */ QUmlClassifier *QUmlRegion::redefinitionContext() const { @@ -150,6 +166,9 @@ QUmlClassifier *QUmlRegion::redefinitionContext() const return 0; } +/*! + Adjusts redefinitionContext to \a redefinitionContext. + */ void QUmlRegion::setRedefinitionContext(QUmlClassifier *redefinitionContext) { // This is a read-only derived association end @@ -171,6 +190,10 @@ void QUmlRegion::setRedefinitionContext(QUmlClassifier *redefinitionContext) /*! The State that owns the Region. If a Region is owned by a State, then it cannot also be owned by a StateMachine. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlState::regions(). */ QUmlState *QUmlRegion::state() const { @@ -179,6 +202,9 @@ QUmlState *QUmlRegion::state() const return _state; } +/*! + Adjusts state to \a state. + */ void QUmlRegion::setState(QUmlState *state) { // This is a read-write association end @@ -197,6 +223,10 @@ void QUmlRegion::setState(QUmlState *state) /*! The StateMachine that owns the Region. If a Region is owned by a StateMachine, then it cannot also be owned by a State. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlStateMachine::regions(). */ QUmlStateMachine *QUmlRegion::stateMachine() const { @@ -205,6 +235,9 @@ QUmlStateMachine *QUmlRegion::stateMachine() const return _stateMachine; } +/*! + Adjusts stateMachine to \a stateMachine. + */ void QUmlRegion::setStateMachine(QUmlStateMachine *stateMachine) { // This is a read-write association end @@ -223,6 +256,12 @@ void QUmlRegion::setStateMachine(QUmlStateMachine *stateMachine) /*! The set of vertices that are owned by this region. + + \sa addSubvertex(), removeSubvertex() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlVertex::container(). */ const QSet<QUmlVertex *> QUmlRegion::subvertices() const { @@ -231,6 +270,11 @@ const QSet<QUmlVertex *> QUmlRegion::subvertices() const return _subvertices; } +/*! + Adds \a subvertex to subvertices. + + \sa subvertices(), removeSubvertex() + */ void QUmlRegion::addSubvertex(QUmlVertex *subvertex) { // This is a read-write association end @@ -251,6 +295,11 @@ void QUmlRegion::addSubvertex(QUmlVertex *subvertex) } } +/*! + Removes \a subvertex from subvertices. + + \sa subvertices(), addSubvertex() + */ void QUmlRegion::removeSubvertex(QUmlVertex *subvertex) { // This is a read-write association end @@ -272,6 +321,12 @@ void QUmlRegion::removeSubvertex(QUmlVertex *subvertex) /*! The set of transitions owned by the region. + + \sa addTransition(), removeTransition() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlTransition::container(). */ const QSet<QUmlTransition *> QUmlRegion::transitions() const { @@ -280,6 +335,11 @@ const QSet<QUmlTransition *> QUmlRegion::transitions() const return _transitions; } +/*! + Adds \a transition to transitions. + + \sa transitions(), removeTransition() + */ void QUmlRegion::addTransition(QUmlTransition *transition) { // This is a read-write association end @@ -300,6 +360,11 @@ void QUmlRegion::addTransition(QUmlTransition *transition) } } +/*! + Removes \a transition from transitions. + + \sa transitions(), addTransition() + */ void QUmlRegion::removeTransition(QUmlTransition *transition) { // This is a read-write association end diff --git a/src/uml/qumlregion.h b/src/uml/qumlregion.h index 4e055581..c5d88dea 100644 --- a/src/uml/qumlregion.h +++ b/src/uml/qumlregion.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlRedefinableElement> #include <QtUml/QUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -99,7 +97,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlRegion) *) -QT_END_HEADER - #endif // QUMLREGION_H diff --git a/src/uml/qumlrelationship.cpp b/src/uml/qumlrelationship.cpp index e9f2ebf8..a9969485 100644 --- a/src/uml/qumlrelationship.cpp +++ b/src/uml/qumlrelationship.cpp @@ -50,11 +50,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief Relationship is an abstract concept that specifies some kind of relationship between elements. + + \b {QUmlRelationship is an abstract class.} */ + +/*! + Creates a new QUmlRelationship. +*/ QUmlRelationship::QUmlRelationship() { } +/*! + Returns a deep-copied clone of the QUmlRelationship. +*/ QModelingElement *QUmlRelationship::clone() const { QUmlRelationship *c = new QUmlRelationship; @@ -67,6 +76,8 @@ QModelingElement *QUmlRelationship::clone() const /*! Specifies the elements related by the Relationship. + + \b {This is a read-only derived union property.} */ const QSet<QUmlElement *> QUmlRelationship::relatedElements() const { @@ -75,6 +86,11 @@ const QSet<QUmlElement *> QUmlRelationship::relatedElements() const return _relatedElements; } +/*! + Adds \a relatedElement to relatedElements. + + \sa relatedElements(), removeRelatedElement() + */ void QUmlRelationship::addRelatedElement(QUmlElement *relatedElement) { // This is a read-only derived union association end @@ -86,6 +102,11 @@ void QUmlRelationship::addRelatedElement(QUmlElement *relatedElement) } } +/*! + Removes \a relatedElement from relatedElements. + + \sa relatedElements(), addRelatedElement() + */ void QUmlRelationship::removeRelatedElement(QUmlElement *relatedElement) { // This is a read-only derived union association end diff --git a/src/uml/qumlrelationship.h b/src/uml/qumlrelationship.h index d2f08b0b..0cd9f6da 100644 --- a/src/uml/qumlrelationship.h +++ b/src/uml/qumlrelationship.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -71,7 +69,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlRelationship) *) -QT_END_HEADER - #endif // QUMLRELATIONSHIP_H diff --git a/src/uml/qumlremovestructuralfeaturevalueaction.cpp b/src/uml/qumlremovestructuralfeaturevalueaction.cpp index 2eb17c59..d7ed933f 100644 --- a/src/uml/qumlremovestructuralfeaturevalueaction.cpp +++ b/src/uml/qumlremovestructuralfeaturevalueaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A remove structural feature value action is a write structural feature action that removes values from structural features. */ + +/*! + Creates a new QUmlRemoveStructuralFeatureValueAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlRemoveStructuralFeatureValueAction::QUmlRemoveStructuralFeatureValueAction(bool createQModelingObject) : _isRemoveDuplicates(false), _removeAt(0) @@ -81,6 +85,9 @@ QUmlRemoveStructuralFeatureValueAction::QUmlRemoveStructuralFeatureValueAction(b _qModelingObject = qobject_cast<QModelingObject *>(new QUmlRemoveStructuralFeatureValueActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlRemoveStructuralFeatureValueAction. +*/ QModelingElement *QUmlRemoveStructuralFeatureValueAction::clone() const { QUmlRemoveStructuralFeatureValueAction *c = new QUmlRemoveStructuralFeatureValueAction; @@ -140,6 +147,9 @@ bool QUmlRemoveStructuralFeatureValueAction::isRemoveDuplicates() const return _isRemoveDuplicates; } +/*! + Adjusts isRemoveDuplicates to \a isRemoveDuplicates. + */ void QUmlRemoveStructuralFeatureValueAction::setRemoveDuplicates(bool isRemoveDuplicates) { // This is a read-write property @@ -152,6 +162,8 @@ void QUmlRemoveStructuralFeatureValueAction::setRemoveDuplicates(bool isRemoveDu /*! Specifies the position of an existing value to remove in ordered nonunique structural features. The type of the pin is UnlimitedNatural, but the value cannot be zero or unlimited. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlRemoveStructuralFeatureValueAction::removeAt() const { @@ -160,6 +172,9 @@ QUmlInputPin *QUmlRemoveStructuralFeatureValueAction::removeAt() const return _removeAt; } +/*! + Adjusts removeAt to \a removeAt. + */ void QUmlRemoveStructuralFeatureValueAction::setRemoveAt(QUmlInputPin *removeAt) { // This is a read-write association end diff --git a/src/uml/qumlremovestructuralfeaturevalueaction.h b/src/uml/qumlremovestructuralfeaturevalueaction.h index 43ee4706..220eb883 100644 --- a/src/uml/qumlremovestructuralfeaturevalueaction.h +++ b/src/uml/qumlremovestructuralfeaturevalueaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlWriteStructuralFeatureAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlRemoveStructuralFeatureValueAction) *) -QT_END_HEADER - #endif // QUMLREMOVESTRUCTURALFEATUREVALUEACTION_H diff --git a/src/uml/qumlremovevariablevalueaction.cpp b/src/uml/qumlremovevariablevalueaction.cpp index e6eabd0b..2c455316 100644 --- a/src/uml/qumlremovevariablevalueaction.cpp +++ b/src/uml/qumlremovevariablevalueaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A remove variable value action is a write variable action that removes values from variables. */ + +/*! + Creates a new QUmlRemoveVariableValueAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlRemoveVariableValueAction::QUmlRemoveVariableValueAction(bool createQModelingObject) : _isRemoveDuplicates(false), _removeAt(0) @@ -81,6 +85,9 @@ QUmlRemoveVariableValueAction::QUmlRemoveVariableValueAction(bool createQModelin _qModelingObject = qobject_cast<QModelingObject *>(new QUmlRemoveVariableValueActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlRemoveVariableValueAction. +*/ QModelingElement *QUmlRemoveVariableValueAction::clone() const { QUmlRemoveVariableValueAction *c = new QUmlRemoveVariableValueAction; @@ -136,6 +143,9 @@ bool QUmlRemoveVariableValueAction::isRemoveDuplicates() const return _isRemoveDuplicates; } +/*! + Adjusts isRemoveDuplicates to \a isRemoveDuplicates. + */ void QUmlRemoveVariableValueAction::setRemoveDuplicates(bool isRemoveDuplicates) { // This is a read-write property @@ -148,6 +158,8 @@ void QUmlRemoveVariableValueAction::setRemoveDuplicates(bool isRemoveDuplicates) /*! Specifies the position of an existing value to remove in ordered nonunique variables. The type of the pin is UnlimitedNatural, but the value cannot be zero or unlimited. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlRemoveVariableValueAction::removeAt() const { @@ -156,6 +168,9 @@ QUmlInputPin *QUmlRemoveVariableValueAction::removeAt() const return _removeAt; } +/*! + Adjusts removeAt to \a removeAt. + */ void QUmlRemoveVariableValueAction::setRemoveAt(QUmlInputPin *removeAt) { // This is a read-write association end diff --git a/src/uml/qumlremovevariablevalueaction.h b/src/uml/qumlremovevariablevalueaction.h index 0ec7cd99..305aa5ae 100644 --- a/src/uml/qumlremovevariablevalueaction.h +++ b/src/uml/qumlremovevariablevalueaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlWriteVariableAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlRemoveVariableValueAction) *) -QT_END_HEADER - #endif // QUMLREMOVEVARIABLEVALUEACTION_H diff --git a/src/uml/qumlreplyaction.cpp b/src/uml/qumlreplyaction.cpp index dc0dde2d..45af8582 100644 --- a/src/uml/qumlreplyaction.cpp +++ b/src/uml/qumlreplyaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A reply action is an action that accepts a set of return values and a value containing return information produced by a previous accept call action. The reply action returns the values to the caller of the previous call, completing execution of the call. */ + +/*! + Creates a new QUmlReplyAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlReplyAction::QUmlReplyAction(bool createQModelingObject) : _replyToCall(0), _returnInformation(0) @@ -81,6 +85,9 @@ QUmlReplyAction::QUmlReplyAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlReplyActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlReplyAction. +*/ QModelingElement *QUmlReplyAction::clone() const { QUmlReplyAction *c = new QUmlReplyAction; @@ -135,6 +142,9 @@ QUmlTrigger *QUmlReplyAction::replyToCall() const return _replyToCall; } +/*! + Adjusts replyToCall to \a replyToCall. + */ void QUmlReplyAction::setReplyToCall(QUmlTrigger *replyToCall) { // This is a read-write association end @@ -148,6 +158,10 @@ void QUmlReplyAction::setReplyToCall(QUmlTrigger *replyToCall) /*! A list of pins containing the reply values of the operation. These values are returned to the caller. + + \sa addReplyValue(), removeReplyValue() + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ const QSet<QUmlInputPin *> QUmlReplyAction::replyValues() const { @@ -156,6 +170,11 @@ const QSet<QUmlInputPin *> QUmlReplyAction::replyValues() const return _replyValues; } +/*! + Adds \a replyValue to replyValues. + + \sa replyValues(), removeReplyValue() + */ void QUmlReplyAction::addReplyValue(QUmlInputPin *replyValue) { // This is a read-write association end @@ -171,6 +190,11 @@ void QUmlReplyAction::addReplyValue(QUmlInputPin *replyValue) } } +/*! + Removes \a replyValue from replyValues. + + \sa replyValues(), addReplyValue() + */ void QUmlReplyAction::removeReplyValue(QUmlInputPin *replyValue) { // This is a read-write association end @@ -187,6 +211,8 @@ void QUmlReplyAction::removeReplyValue(QUmlInputPin *replyValue) /*! A pin containing the return information value produced by an earlier AcceptCallAction. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlReplyAction::returnInformation() const { @@ -195,6 +221,9 @@ QUmlInputPin *QUmlReplyAction::returnInformation() const return _returnInformation; } +/*! + Adjusts returnInformation to \a returnInformation. + */ void QUmlReplyAction::setReturnInformation(QUmlInputPin *returnInformation) { // This is a read-write association end diff --git a/src/uml/qumlreplyaction.h b/src/uml/qumlreplyaction.h index 79f12138..8cc78f94 100644 --- a/src/uml/qumlreplyaction.h +++ b/src/uml/qumlreplyaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -80,7 +78,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlReplyAction) *) -QT_END_HEADER - #endif // QUMLREPLYACTION_H diff --git a/src/uml/qumlsendobjectaction.cpp b/src/uml/qumlsendobjectaction.cpp index 6d1394ca..4b555feb 100644 --- a/src/uml/qumlsendobjectaction.cpp +++ b/src/uml/qumlsendobjectaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A send object action is an action that transmits an object to the target object, where it may invoke behavior such as the firing of state machine transitions or the execution of an activity. The value of the object is available to the execution of invoked behaviors. The requestor continues execution immediately. Any reply message is ignored and is not transmitted to the requestor. */ + +/*! + Creates a new QUmlSendObjectAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlSendObjectAction::QUmlSendObjectAction(bool createQModelingObject) : _request(0), _target(0) @@ -81,6 +85,9 @@ QUmlSendObjectAction::QUmlSendObjectAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlSendObjectActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlSendObjectAction. +*/ QModelingElement *QUmlSendObjectAction::clone() const { QUmlSendObjectAction *c = new QUmlSendObjectAction; @@ -127,6 +134,8 @@ QModelingElement *QUmlSendObjectAction::clone() const /*! The request object, which is transmitted to the target object. The object may be copied in transmission, so identity might not be preserved. + + \b {Redefined property(ies):} QUmlInvocationAction::arguments(). */ QUmlInputPin *QUmlSendObjectAction::request() const { @@ -135,6 +144,9 @@ QUmlInputPin *QUmlSendObjectAction::request() const return _request; } +/*! + Adjusts request to \a request. + */ void QUmlSendObjectAction::setRequest(QUmlInputPin *request) { // This is a read-write association end @@ -156,6 +168,8 @@ void QUmlSendObjectAction::setRequest(QUmlInputPin *request) /*! The target object to which the object is sent. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlSendObjectAction::target() const { @@ -164,6 +178,9 @@ QUmlInputPin *QUmlSendObjectAction::target() const return _target; } +/*! + Adjusts target to \a target. + */ void QUmlSendObjectAction::setTarget(QUmlInputPin *target) { // This is a read-write association end diff --git a/src/uml/qumlsendobjectaction.h b/src/uml/qumlsendobjectaction.h index 8dbd9119..d24bee41 100644 --- a/src/uml/qumlsendobjectaction.h +++ b/src/uml/qumlsendobjectaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInvocationAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlSendObjectAction) *) -QT_END_HEADER - #endif // QUMLSENDOBJECTACTION_H diff --git a/src/uml/qumlsendsignalaction.cpp b/src/uml/qumlsendsignalaction.cpp index 2bd119d6..1de9ca25 100644 --- a/src/uml/qumlsendsignalaction.cpp +++ b/src/uml/qumlsendsignalaction.cpp @@ -74,6 +74,10 @@ QT_BEGIN_NAMESPACE \brief A send signal action is an action that creates a signal instance from its inputs, and transmits it to the target object, where it may cause the firing of a state machine transition or the execution of an activity. The argument values are available to the execution of associated behaviors. The requestor continues execution immediately. Any reply message is ignored and is not transmitted to the requestor. If the input is already a signal instance, use a send object action. */ + +/*! + Creates a new QUmlSendSignalAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlSendSignalAction::QUmlSendSignalAction(bool createQModelingObject) : _signal(0), _target(0) @@ -82,6 +86,9 @@ QUmlSendSignalAction::QUmlSendSignalAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlSendSignalActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlSendSignalAction. +*/ QModelingElement *QUmlSendSignalAction::clone() const { QUmlSendSignalAction *c = new QUmlSendSignalAction; @@ -138,6 +145,9 @@ QUmlSignal *QUmlSendSignalAction::signal() const return _signal; } +/*! + Adjusts signal to \a signal. + */ void QUmlSendSignalAction::setSignal(QUmlSignal *signal) { // This is a read-write association end @@ -151,6 +161,8 @@ void QUmlSendSignalAction::setSignal(QUmlSignal *signal) /*! The target object to which the signal is sent. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlSendSignalAction::target() const { @@ -159,6 +171,9 @@ QUmlInputPin *QUmlSendSignalAction::target() const return _target; } +/*! + Adjusts target to \a target. + */ void QUmlSendSignalAction::setTarget(QUmlInputPin *target) { // This is a read-write association end diff --git a/src/uml/qumlsendsignalaction.h b/src/uml/qumlsendsignalaction.h index 4c56f573..c7121541 100644 --- a/src/uml/qumlsendsignalaction.h +++ b/src/uml/qumlsendsignalaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInvocationAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlSendSignalAction) *) -QT_END_HEADER - #endif // QUMLSENDSIGNALACTION_H diff --git a/src/uml/qumlsequencenode.cpp b/src/uml/qumlsequencenode.cpp index ed79811a..9c1e4e2c 100644 --- a/src/uml/qumlsequencenode.cpp +++ b/src/uml/qumlsequencenode.cpp @@ -76,6 +76,10 @@ QT_BEGIN_NAMESPACE \brief A sequence node is a structured activity node that executes its actions in order. */ + +/*! + Creates a new QUmlSequenceNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlSequenceNode::QUmlSequenceNode(bool createQModelingObject) : QUmlStructuredActivityNode(false) { @@ -83,6 +87,9 @@ QUmlSequenceNode::QUmlSequenceNode(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlSequenceNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlSequenceNode. +*/ QModelingElement *QUmlSequenceNode::clone() const { QUmlSequenceNode *c = new QUmlSequenceNode; @@ -140,6 +147,10 @@ QModelingElement *QUmlSequenceNode::clone() const /*! An ordered set of executable nodes. + + \sa addExecutableNode(), removeExecutableNode() + + \b {Redefined property(ies):} QUmlStructuredActivityNode::nodes(). */ const QList<QUmlExecutableNode *> QUmlSequenceNode::executableNodes() const { @@ -148,6 +159,11 @@ const QList<QUmlExecutableNode *> QUmlSequenceNode::executableNodes() const return _executableNodes; } +/*! + Adds \a executableNode to executableNodes. + + \sa executableNodes(), removeExecutableNode() + */ void QUmlSequenceNode::addExecutableNode(QUmlExecutableNode *executableNode) { // This is a read-write association end @@ -163,6 +179,11 @@ void QUmlSequenceNode::addExecutableNode(QUmlExecutableNode *executableNode) } } +/*! + Removes \a executableNode from executableNodes. + + \sa executableNodes(), addExecutableNode() + */ void QUmlSequenceNode::removeExecutableNode(QUmlExecutableNode *executableNode) { // This is a read-write association end diff --git a/src/uml/qumlsequencenode.h b/src/uml/qumlsequencenode.h index bfed482b..a5bc5d8a 100644 --- a/src/uml/qumlsequencenode.h +++ b/src/uml/qumlsequencenode.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlStructuredActivityNode> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -73,7 +71,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlSequenceNode) *) -QT_END_HEADER - #endif // QUMLSEQUENCENODE_H diff --git a/src/uml/qumlsignal.cpp b/src/uml/qumlsignal.cpp index 1e8f447f..7d94391d 100644 --- a/src/uml/qumlsignal.cpp +++ b/src/uml/qumlsignal.cpp @@ -78,12 +78,19 @@ QT_BEGIN_NAMESPACE \brief A signal is a specification of send request instances communicated between objects. The receiving object handles the received request instances as specified by its receptions. The data carried by a send request (which was passed to it by the send invocation occurrence that caused that request) are represented as attributes of the signal. A signal is defined independently of the classifiers handling the signal occurrence. */ + +/*! + Creates a new QUmlSignal. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlSignal::QUmlSignal(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlSignalObject(this)); } +/*! + Returns a deep-copied clone of the QUmlSignal. +*/ QModelingElement *QUmlSignal::clone() const { QUmlSignal *c = new QUmlSignal; @@ -139,6 +146,10 @@ QModelingElement *QUmlSignal::clone() const /*! The attributes owned by the signal. + + \sa addOwnedAttribute(), removeOwnedAttribute() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(), QUmlClassifier::attributes(). */ const QList<QUmlProperty *> QUmlSignal::ownedAttributes() const { @@ -147,6 +158,11 @@ const QList<QUmlProperty *> QUmlSignal::ownedAttributes() const return _ownedAttributes; } +/*! + Adds \a ownedAttribute to ownedAttributes. + + \sa ownedAttributes(), removeOwnedAttribute() + */ void QUmlSignal::addOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end @@ -163,6 +179,11 @@ void QUmlSignal::addOwnedAttribute(QUmlProperty *ownedAttribute) } } +/*! + Removes \a ownedAttribute from ownedAttributes. + + \sa ownedAttributes(), addOwnedAttribute() + */ void QUmlSignal::removeOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end diff --git a/src/uml/qumlsignal.h b/src/uml/qumlsignal.h index d948e149..a55cecbe 100644 --- a/src/uml/qumlsignal.h +++ b/src/uml/qumlsignal.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -73,7 +71,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlSignal) *) -QT_END_HEADER - #endif // QUMLSIGNAL_H diff --git a/src/uml/qumlsignalevent.cpp b/src/uml/qumlsignalevent.cpp index dfe50d9e..1985c22e 100644 --- a/src/uml/qumlsignalevent.cpp +++ b/src/uml/qumlsignalevent.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief A signal event represents the receipt of an asynchronous signal instance. A signal event may, for example, cause a state machine to trigger a transition. */ + +/*! + Creates a new QUmlSignalEvent. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlSignalEvent::QUmlSignalEvent(bool createQModelingObject) : _signal(0) { @@ -69,6 +73,9 @@ QUmlSignalEvent::QUmlSignalEvent(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlSignalEventObject(this)); } +/*! + Returns a deep-copied clone of the QUmlSignalEvent. +*/ QModelingElement *QUmlSignalEvent::clone() const { QUmlSignalEvent *c = new QUmlSignalEvent; @@ -101,6 +108,9 @@ QUmlSignal *QUmlSignalEvent::signal() const return _signal; } +/*! + Adjusts signal to \a signal. + */ void QUmlSignalEvent::setSignal(QUmlSignal *signal) { // This is a read-write association end diff --git a/src/uml/qumlsignalevent.h b/src/uml/qumlsignalevent.h index f902c4ea..52ffefe0 100644 --- a/src/uml/qumlsignalevent.h +++ b/src/uml/qumlsignalevent.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlMessageEvent> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlSignalEvent) *) -QT_END_HEADER - #endif // QUMLSIGNALEVENT_H diff --git a/src/uml/qumlslot.cpp b/src/uml/qumlslot.cpp index da550852..ff3c9be6 100644 --- a/src/uml/qumlslot.cpp +++ b/src/uml/qumlslot.cpp @@ -56,6 +56,10 @@ QT_BEGIN_NAMESPACE \brief A slot specifies that an entity modeled by an instance specification has a value or values for a specific structural feature. */ + +/*! + Creates a new QUmlSlot. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlSlot::QUmlSlot(bool createQModelingObject) : _definingFeature(0), _owningInstance(0) @@ -64,6 +68,9 @@ QUmlSlot::QUmlSlot(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlSlotObject(this)); } +/*! + Returns a deep-copied clone of the QUmlSlot. +*/ QModelingElement *QUmlSlot::clone() const { QUmlSlot *c = new QUmlSlot; @@ -90,6 +97,9 @@ QUmlStructuralFeature *QUmlSlot::definingFeature() const return _definingFeature; } +/*! + Adjusts definingFeature to \a definingFeature. + */ void QUmlSlot::setDefiningFeature(QUmlStructuralFeature *definingFeature) { // This is a read-write association end @@ -103,6 +113,10 @@ void QUmlSlot::setDefiningFeature(QUmlStructuralFeature *definingFeature) /*! The instance specification that owns this slot. + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlInstanceSpecification::slots_(). */ QUmlInstanceSpecification *QUmlSlot::owningInstance() const { @@ -111,6 +125,9 @@ QUmlInstanceSpecification *QUmlSlot::owningInstance() const return _owningInstance; } +/*! + Adjusts owningInstance to \a owningInstance. + */ void QUmlSlot::setOwningInstance(QUmlInstanceSpecification *owningInstance) { // This is a read-write association end @@ -129,6 +146,10 @@ void QUmlSlot::setOwningInstance(QUmlInstanceSpecification *owningInstance) /*! The value or values corresponding to the defining feature for the owning instance specification. + + \sa addValue(), removeValue() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QList<QUmlValueSpecification *> QUmlSlot::values() const { @@ -137,6 +158,11 @@ const QList<QUmlValueSpecification *> QUmlSlot::values() const return _values; } +/*! + Adds \a value to values. + + \sa values(), removeValue() + */ void QUmlSlot::addValue(QUmlValueSpecification *value) { // This is a read-write association end @@ -152,6 +178,11 @@ void QUmlSlot::addValue(QUmlValueSpecification *value) } } +/*! + Removes \a value from values. + + \sa values(), addValue() + */ void QUmlSlot::removeValue(QUmlValueSpecification *value) { // This is a read-write association end diff --git a/src/uml/qumlslot.h b/src/uml/qumlslot.h index 9bd17f02..72df9dd6 100644 --- a/src/uml/qumlslot.h +++ b/src/uml/qumlslot.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlSlot) *) -QT_END_HEADER - #endif // QUMLSLOT_H diff --git a/src/uml/qumlstartclassifierbehavioraction.cpp b/src/uml/qumlstartclassifierbehavioraction.cpp index 6259afc7..650566cf 100644 --- a/src/uml/qumlstartclassifierbehavioraction.cpp +++ b/src/uml/qumlstartclassifierbehavioraction.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief A start classifier behavior action is an action that starts the classifier behavior of the input. */ + +/*! + Creates a new QUmlStartClassifierBehaviorAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlStartClassifierBehaviorAction::QUmlStartClassifierBehaviorAction(bool createQModelingObject) : _object(0) { @@ -79,6 +83,9 @@ QUmlStartClassifierBehaviorAction::QUmlStartClassifierBehaviorAction(bool create _qModelingObject = qobject_cast<QModelingObject *>(new QUmlStartClassifierBehaviorActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlStartClassifierBehaviorAction. +*/ QModelingElement *QUmlStartClassifierBehaviorAction::clone() const { QUmlStartClassifierBehaviorAction *c = new QUmlStartClassifierBehaviorAction; @@ -121,6 +128,8 @@ QModelingElement *QUmlStartClassifierBehaviorAction::clone() const /*! Holds the object on which to start the owned behavior. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlStartClassifierBehaviorAction::object() const { @@ -129,6 +138,9 @@ QUmlInputPin *QUmlStartClassifierBehaviorAction::object() const return _object; } +/*! + Adjusts object to \a object. + */ void QUmlStartClassifierBehaviorAction::setObject(QUmlInputPin *object) { // This is a read-write association end diff --git a/src/uml/qumlstartclassifierbehavioraction.h b/src/uml/qumlstartclassifierbehavioraction.h index 20ec6415..9655fd08 100644 --- a/src/uml/qumlstartclassifierbehavioraction.h +++ b/src/uml/qumlstartclassifierbehavioraction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlStartClassifierBehaviorAction) *) -QT_END_HEADER - #endif // QUMLSTARTCLASSIFIERBEHAVIORACTION_H diff --git a/src/uml/qumlstartobjectbehavioraction.cpp b/src/uml/qumlstartobjectbehavioraction.cpp index 94183eb9..570b81e9 100644 --- a/src/uml/qumlstartobjectbehavioraction.cpp +++ b/src/uml/qumlstartobjectbehavioraction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief StartObjectBehaviorAction is an action that starts the execution either of a directly instantiated behavior or of the classifier behavior of an object. Argument values may be supplied for the input parameters of the behavior. If the behavior is invoked synchronously, then output values may be obtained for output parameters. */ + +/*! + Creates a new QUmlStartObjectBehaviorAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlStartObjectBehaviorAction::QUmlStartObjectBehaviorAction(bool createQModelingObject) : _object(0) { @@ -80,6 +84,9 @@ QUmlStartObjectBehaviorAction::QUmlStartObjectBehaviorAction(bool createQModelin _qModelingObject = qobject_cast<QModelingObject *>(new QUmlStartObjectBehaviorActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlStartObjectBehaviorAction. +*/ QModelingElement *QUmlStartObjectBehaviorAction::clone() const { QUmlStartObjectBehaviorAction *c = new QUmlStartObjectBehaviorAction; @@ -129,6 +136,8 @@ QModelingElement *QUmlStartObjectBehaviorAction::clone() const /*! Holds the object which is either a behavior to be started or has a classifier behavior to be started. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlStartObjectBehaviorAction::object() const { @@ -137,6 +146,9 @@ QUmlInputPin *QUmlStartObjectBehaviorAction::object() const return _object; } +/*! + Adjusts object to \a object. + */ void QUmlStartObjectBehaviorAction::setObject(QUmlInputPin *object) { // This is a read-write association end diff --git a/src/uml/qumlstartobjectbehavioraction.h b/src/uml/qumlstartobjectbehavioraction.h index ed9fa791..2da2f133 100644 --- a/src/uml/qumlstartobjectbehavioraction.h +++ b/src/uml/qumlstartobjectbehavioraction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlCallAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlStartObjectBehaviorAction) *) -QT_END_HEADER - #endif // QUMLSTARTOBJECTBEHAVIORACTION_H diff --git a/src/uml/qumlstate.cpp b/src/uml/qumlstate.cpp index f1ad8a86..3c1fa870 100644 --- a/src/uml/qumlstate.cpp +++ b/src/uml/qumlstate.cpp @@ -70,6 +70,10 @@ QT_BEGIN_NAMESPACE \brief A state models a situation during which some (usually implicit) invariant condition holds.The states of protocol state machines are exposed to the users of their context classifiers. A protocol state represents an exposed stable situation of its context classifier: when an instance of the classifier is not processing any operation, users of this instance can always know its state configuration. */ + +/*! + Creates a new QUmlState. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlState::QUmlState(bool createQModelingObject) : _doActivity(0), _entry(0), @@ -82,6 +86,9 @@ QUmlState::QUmlState(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlStateObject(this)); } +/*! + Returns a deep-copied clone of the QUmlState. +*/ QModelingElement *QUmlState::clone() const { QUmlState *c = new QUmlState; @@ -129,6 +136,12 @@ QModelingElement *QUmlState::clone() const /*! The entry and exit connection points used in conjunction with this (submachine) state, i.e. as targets and sources, respectively, in the region with the submachine state. A connection point reference references the corresponding definition of a connection point pseudostate in the statemachine referenced by the submachinestate. + + \sa addConnection(), removeConnection() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlConnectionPointReference::state(). */ const QSet<QUmlConnectionPointReference *> QUmlState::connections() const { @@ -137,6 +150,11 @@ const QSet<QUmlConnectionPointReference *> QUmlState::connections() const return _connections; } +/*! + Adds \a connection to connections. + + \sa connections(), removeConnection() + */ void QUmlState::addConnection(QUmlConnectionPointReference *connection) { // This is a read-write association end @@ -157,6 +175,11 @@ void QUmlState::addConnection(QUmlConnectionPointReference *connection) } } +/*! + Removes \a connection from connections. + + \sa connections(), addConnection() + */ void QUmlState::removeConnection(QUmlConnectionPointReference *connection) { // This is a read-write association end @@ -178,6 +201,12 @@ void QUmlState::removeConnection(QUmlConnectionPointReference *connection) /*! The entry and exit pseudostates of a composite state. These can only be entry or exit Pseudostates, and they must have different names. They can only be defined for composite states. + + \sa addConnectionPoint(), removeConnectionPoint() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlPseudostate::state(). */ const QSet<QUmlPseudostate *> QUmlState::connectionPoints() const { @@ -186,6 +215,11 @@ const QSet<QUmlPseudostate *> QUmlState::connectionPoints() const return _connectionPoints; } +/*! + Adds \a connectionPoint to connectionPoints. + + \sa connectionPoints(), removeConnectionPoint() + */ void QUmlState::addConnectionPoint(QUmlPseudostate *connectionPoint) { // This is a read-write association end @@ -206,6 +240,11 @@ void QUmlState::addConnectionPoint(QUmlPseudostate *connectionPoint) } } +/*! + Removes \a connectionPoint from connectionPoints. + + \sa connectionPoints(), addConnectionPoint() + */ void QUmlState::removeConnectionPoint(QUmlPseudostate *connectionPoint) { // This is a read-write association end @@ -227,6 +266,10 @@ void QUmlState::removeConnectionPoint(QUmlPseudostate *connectionPoint) /*! A list of triggers that are candidates to be retained by the state machine if they trigger no transitions out of the state (not consumed). A deferred trigger is retained until the state machine reaches a state configuration where it is no longer deferred. + + \sa addDeferrableTrigger(), removeDeferrableTrigger() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlTrigger *> QUmlState::deferrableTriggers() const { @@ -235,6 +278,11 @@ const QSet<QUmlTrigger *> QUmlState::deferrableTriggers() const return _deferrableTriggers; } +/*! + Adds \a deferrableTrigger to deferrableTriggers. + + \sa deferrableTriggers(), removeDeferrableTrigger() + */ void QUmlState::addDeferrableTrigger(QUmlTrigger *deferrableTrigger) { // This is a read-write association end @@ -250,6 +298,11 @@ void QUmlState::addDeferrableTrigger(QUmlTrigger *deferrableTrigger) } } +/*! + Removes \a deferrableTrigger from deferrableTriggers. + + \sa deferrableTriggers(), addDeferrableTrigger() + */ void QUmlState::removeDeferrableTrigger(QUmlTrigger *deferrableTrigger) { // This is a read-write association end @@ -266,6 +319,8 @@ void QUmlState::removeDeferrableTrigger(QUmlTrigger *deferrableTrigger) /*! An optional behavior that is executed while being in the state. The execution starts when this state is entered, and stops either by itself, or when the state is exited, whichever comes first. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlBehavior *QUmlState::doActivity() const { @@ -274,6 +329,9 @@ QUmlBehavior *QUmlState::doActivity() const return _doActivity; } +/*! + Adjusts doActivity to \a doActivity. + */ void QUmlState::setDoActivity(QUmlBehavior *doActivity) { // This is a read-write association end @@ -296,6 +354,8 @@ void QUmlState::setDoActivity(QUmlBehavior *doActivity) /*! An optional behavior that is executed whenever this state is entered regardless of the transition taken to reach the state. If defined, entry actions are always executed to completion prior to any internal behavior or transitions performed within the state. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlBehavior *QUmlState::entry() const { @@ -304,6 +364,9 @@ QUmlBehavior *QUmlState::entry() const return _entry; } +/*! + Adjusts entry to \a entry. + */ void QUmlState::setEntry(QUmlBehavior *entry) { // This is a read-write association end @@ -326,6 +389,8 @@ void QUmlState::setEntry(QUmlBehavior *entry) /*! An optional behavior that is executed whenever this state is exited regardless of which transition was taken out of the state. If defined, exit actions are always executed to completion only after all internal activities and transition actions have completed execution. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlBehavior *QUmlState::exit() const { @@ -334,6 +399,9 @@ QUmlBehavior *QUmlState::exit() const return _exit; } +/*! + Adjusts exit to \a exit. + */ void QUmlState::setExit(QUmlBehavior *exit) { // This is a read-write association end @@ -356,6 +424,8 @@ void QUmlState::setExit(QUmlBehavior *exit) /*! A state with isComposite=true is said to be a composite state. A composite state is a state that contains at least one region. + + \b {This is a read-only derived property.} */ bool QUmlState::isComposite() const { @@ -366,6 +436,9 @@ bool QUmlState::isComposite() const return bool(); } +/*! + Adjusts isComposite to \a isComposite. + */ void QUmlState::setComposite(bool isComposite) { // This is a read-only derived property @@ -380,6 +453,8 @@ void QUmlState::setComposite(bool isComposite) /*! A state with isOrthogonal=true is said to be an orthogonal composite state. An orthogonal composite state contains two or more regions. + + \b {This is a read-only derived property.} */ bool QUmlState::isOrthogonal() const { @@ -390,6 +465,9 @@ bool QUmlState::isOrthogonal() const return bool(); } +/*! + Adjusts isOrthogonal to \a isOrthogonal. + */ void QUmlState::setOrthogonal(bool isOrthogonal) { // This is a read-only derived property @@ -404,6 +482,8 @@ void QUmlState::setOrthogonal(bool isOrthogonal) /*! A state with isSimple=true is said to be a simple state. A simple state does not have any regions and it does not refer to any submachine state machine. + + \b {This is a read-only derived property.} */ bool QUmlState::isSimple() const { @@ -414,6 +494,9 @@ bool QUmlState::isSimple() const return bool(); } +/*! + Adjusts isSimple to \a isSimple. + */ void QUmlState::setSimple(bool isSimple) { // This is a read-only derived property @@ -428,6 +511,8 @@ void QUmlState::setSimple(bool isSimple) /*! A state with isSubmachineState=true is said to be a submachine state. Such a state refers to a state machine (submachine). + + \b {This is a read-only derived property.} */ bool QUmlState::isSubmachineState() const { @@ -438,6 +523,9 @@ bool QUmlState::isSubmachineState() const return bool(); } +/*! + Adjusts isSubmachineState to \a isSubmachineState. + */ void QUmlState::setSubmachineState(bool isSubmachineState) { // This is a read-only derived property @@ -452,6 +540,8 @@ void QUmlState::setSubmachineState(bool isSubmachineState) /*! The state of which this state is a redefinition. + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinedElements(). */ QUmlState *QUmlState::redefinedState() const { @@ -460,6 +550,9 @@ QUmlState *QUmlState::redefinedState() const return _redefinedState; } +/*! + Adjusts redefinedState to \a redefinedState. + */ void QUmlState::setRedefinedState(QUmlState *redefinedState) { // This is a read-write association end @@ -481,6 +574,10 @@ void QUmlState::setRedefinedState(QUmlState *redefinedState) /*! References the classifier in which context this element may be redefined. + + \b {This is a read-only derived property.} + + \b {Redefined property(ies):} QUmlRedefinableElement::redefinitionContexts(). */ QUmlClassifier *QUmlState::redefinitionContext() const { @@ -491,6 +588,9 @@ QUmlClassifier *QUmlState::redefinitionContext() const return 0; } +/*! + Adjusts redefinitionContext to \a redefinitionContext. + */ void QUmlState::setRedefinitionContext(QUmlClassifier *redefinitionContext) { // This is a read-only derived association end @@ -512,6 +612,12 @@ void QUmlState::setRedefinitionContext(QUmlClassifier *redefinitionContext) /*! The regions owned directly by the state. + + \sa addRegion(), removeRegion() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlRegion::state(). */ const QSet<QUmlRegion *> QUmlState::regions() const { @@ -520,6 +626,11 @@ const QSet<QUmlRegion *> QUmlState::regions() const return _regions; } +/*! + Adds \a region to regions. + + \sa regions(), removeRegion() + */ void QUmlState::addRegion(QUmlRegion *region) { // This is a read-write association end @@ -540,6 +651,11 @@ void QUmlState::addRegion(QUmlRegion *region) } } +/*! + Removes \a region from regions. + + \sa regions(), addRegion() + */ void QUmlState::removeRegion(QUmlRegion *region) { // This is a read-write association end @@ -561,6 +677,8 @@ void QUmlState::removeRegion(QUmlRegion *region) /*! Specifies conditions that are always true when this state is the current state. In protocol state machines, state invariants are additional conditions to the preconditions of the outgoing transitions, and to the postcondition of the incoming transitions. + + \b {Subsetted property(ies):} QUmlNamespace::ownedRules(). */ QUmlConstraint *QUmlState::stateInvariant() const { @@ -569,6 +687,9 @@ QUmlConstraint *QUmlState::stateInvariant() const return _stateInvariant; } +/*! + Adjusts stateInvariant to \a stateInvariant. + */ void QUmlState::setStateInvariant(QUmlConstraint *stateInvariant) { // This is a read-write association end @@ -591,6 +712,8 @@ void QUmlState::setStateInvariant(QUmlConstraint *stateInvariant) /*! The state machine that is to be inserted in place of the (submachine) state. + + \b {Opposite property(ies):} QUmlStateMachine::submachineStates(). */ QUmlStateMachine *QUmlState::submachine() const { @@ -599,6 +722,9 @@ QUmlStateMachine *QUmlState::submachine() const return _submachine; } +/*! + Adjusts submachine to \a submachine. + */ void QUmlState::setSubmachine(QUmlStateMachine *submachine) { // This is a read-write association end diff --git a/src/uml/qumlstate.h b/src/uml/qumlstate.h index a371fa02..2db8bfe9 100644 --- a/src/uml/qumlstate.h +++ b/src/uml/qumlstate.h @@ -47,8 +47,6 @@ #include <QtUml/QUmlRedefinableElement> #include <QtUml/QUmlVertex> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -127,7 +125,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlState) *) -QT_END_HEADER - #endif // QUMLSTATE_H diff --git a/src/uml/qumlstateinvariant.cpp b/src/uml/qumlstateinvariant.cpp index 2bf00427..be6bf730 100644 --- a/src/uml/qumlstateinvariant.cpp +++ b/src/uml/qumlstateinvariant.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief A state invariant is a runtime constraint on the participants of the interaction. It may be used to specify a variety of different kinds of constraints, such as values of attributes or variables, internal or external states, and so on. A state invariant is an interaction fragment and it is placed on a lifeline. */ + +/*! + Creates a new QUmlStateInvariant. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlStateInvariant::QUmlStateInvariant(bool createQModelingObject) : _covered(0), _invariant(0) @@ -72,6 +76,9 @@ QUmlStateInvariant::QUmlStateInvariant(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlStateInvariantObject(this)); } +/*! + Returns a deep-copied clone of the QUmlStateInvariant. +*/ QModelingElement *QUmlStateInvariant::clone() const { QUmlStateInvariant *c = new QUmlStateInvariant; @@ -100,6 +107,8 @@ QModelingElement *QUmlStateInvariant::clone() const /*! References the Lifeline on which the StateInvariant appears. + + \b {Redefined property(ies):} QUmlInteractionFragment::covered(). */ QUmlLifeline *QUmlStateInvariant::covered() const { @@ -108,6 +117,9 @@ QUmlLifeline *QUmlStateInvariant::covered() const return _covered; } +/*! + Adjusts covered to \a covered. + */ void QUmlStateInvariant::setCovered(QUmlLifeline *covered) { // This is a read-write association end @@ -128,6 +140,8 @@ void QUmlStateInvariant::setCovered(QUmlLifeline *covered) /*! A Constraint that should hold at runtime for this StateInvariant + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlConstraint *QUmlStateInvariant::invariant() const { @@ -136,6 +150,9 @@ QUmlConstraint *QUmlStateInvariant::invariant() const return _invariant; } +/*! + Adjusts invariant to \a invariant. + */ void QUmlStateInvariant::setInvariant(QUmlConstraint *invariant) { // This is a read-write association end diff --git a/src/uml/qumlstateinvariant.h b/src/uml/qumlstateinvariant.h index ddd4a3a0..f0ee20fc 100644 --- a/src/uml/qumlstateinvariant.h +++ b/src/uml/qumlstateinvariant.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInteractionFragment> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlStateInvariant) *) -QT_END_HEADER - #endif // QUMLSTATEINVARIANT_H diff --git a/src/uml/qumlstatemachine.cpp b/src/uml/qumlstatemachine.cpp index 079d6705..2931059c 100644 --- a/src/uml/qumlstatemachine.cpp +++ b/src/uml/qumlstatemachine.cpp @@ -94,12 +94,19 @@ QT_BEGIN_NAMESPACE \brief State machines can be used to express the behavior of part of a system. Behavior is modeled as a traversal of a graph of state nodes interconnected by one or more joined transition arcs that are triggered by the dispatching of series of (event) occurrences. During this traversal, the state machine executes a series of activities associated with various elements of the state machine. */ + +/*! + Creates a new QUmlStateMachine. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlStateMachine::QUmlStateMachine(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlStateMachineObject(this)); } +/*! + Returns a deep-copied clone of the QUmlStateMachine. +*/ QModelingElement *QUmlStateMachine::clone() const { QUmlStateMachine *c = new QUmlStateMachine; @@ -189,6 +196,12 @@ QModelingElement *QUmlStateMachine::clone() const /*! The connection points defined for this state machine. They represent the interface of the state machine when used as part of submachine state. + + \sa addConnectionPoint(), removeConnectionPoint() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlPseudostate::stateMachine(). */ const QSet<QUmlPseudostate *> QUmlStateMachine::connectionPoints() const { @@ -197,6 +210,11 @@ const QSet<QUmlPseudostate *> QUmlStateMachine::connectionPoints() const return _connectionPoints; } +/*! + Adds \a connectionPoint to connectionPoints. + + \sa connectionPoints(), removeConnectionPoint() + */ void QUmlStateMachine::addConnectionPoint(QUmlPseudostate *connectionPoint) { // This is a read-write association end @@ -217,6 +235,11 @@ void QUmlStateMachine::addConnectionPoint(QUmlPseudostate *connectionPoint) } } +/*! + Removes \a connectionPoint from connectionPoints. + + \sa connectionPoints(), addConnectionPoint() + */ void QUmlStateMachine::removeConnectionPoint(QUmlPseudostate *connectionPoint) { // This is a read-write association end @@ -238,6 +261,10 @@ void QUmlStateMachine::removeConnectionPoint(QUmlPseudostate *connectionPoint) /*! The state machines of which this is an extension. + + \sa addExtendedStateMachine(), removeExtendedStateMachine() + + \b {Redefined property(ies):} QUmlBehavior::redefinedBehaviors(). */ const QSet<QUmlStateMachine *> QUmlStateMachine::extendedStateMachines() const { @@ -246,6 +273,11 @@ const QSet<QUmlStateMachine *> QUmlStateMachine::extendedStateMachines() const return _extendedStateMachines; } +/*! + Adds \a extendedStateMachine to extendedStateMachines. + + \sa extendedStateMachines(), removeExtendedStateMachine() + */ void QUmlStateMachine::addExtendedStateMachine(QUmlStateMachine *extendedStateMachine) { // This is a read-write association end @@ -260,6 +292,11 @@ void QUmlStateMachine::addExtendedStateMachine(QUmlStateMachine *extendedStateMa } } +/*! + Removes \a extendedStateMachine from extendedStateMachines. + + \sa extendedStateMachines(), addExtendedStateMachine() + */ void QUmlStateMachine::removeExtendedStateMachine(QUmlStateMachine *extendedStateMachine) { // This is a read-write association end @@ -274,6 +311,12 @@ void QUmlStateMachine::removeExtendedStateMachine(QUmlStateMachine *extendedStat /*! The regions owned directly by the state machine. + + \sa addRegion(), removeRegion() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlRegion::stateMachine(). */ const QSet<QUmlRegion *> QUmlStateMachine::regions() const { @@ -282,6 +325,11 @@ const QSet<QUmlRegion *> QUmlStateMachine::regions() const return _regions; } +/*! + Adds \a region to regions. + + \sa regions(), removeRegion() + */ void QUmlStateMachine::addRegion(QUmlRegion *region) { // This is a read-write association end @@ -302,6 +350,11 @@ void QUmlStateMachine::addRegion(QUmlRegion *region) } } +/*! + Removes \a region from regions. + + \sa regions(), addRegion() + */ void QUmlStateMachine::removeRegion(QUmlRegion *region) { // This is a read-write association end @@ -323,6 +376,10 @@ void QUmlStateMachine::removeRegion(QUmlRegion *region) /*! References the submachine(s) in case of a submachine state. Multiple machines are referenced in case of a concurrent state. + + \sa addSubmachineState(), removeSubmachineState() + + \b {Opposite property(ies):} QUmlState::submachine(). */ const QSet<QUmlState *> QUmlStateMachine::submachineStates() const { @@ -331,6 +388,11 @@ const QSet<QUmlState *> QUmlStateMachine::submachineStates() const return _submachineStates; } +/*! + Adds \a submachineState to submachineStates. + + \sa submachineStates(), removeSubmachineState() + */ void QUmlStateMachine::addSubmachineState(QUmlState *submachineState) { // This is a read-write association end @@ -347,6 +409,11 @@ void QUmlStateMachine::addSubmachineState(QUmlState *submachineState) } } +/*! + Removes \a submachineState from submachineStates. + + \sa submachineStates(), addSubmachineState() + */ void QUmlStateMachine::removeSubmachineState(QUmlState *submachineState) { // This is a read-write association end diff --git a/src/uml/qumlstatemachine.h b/src/uml/qumlstatemachine.h index d0105944..cb09386f 100644 --- a/src/uml/qumlstatemachine.h +++ b/src/uml/qumlstatemachine.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlBehavior> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -95,7 +93,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlStateMachine) *) -QT_END_HEADER - #endif // QUMLSTATEMACHINE_H diff --git a/src/uml/qumlstereotype.cpp b/src/uml/qumlstereotype.cpp index 44b9c61e..81c13769 100644 --- a/src/uml/qumlstereotype.cpp +++ b/src/uml/qumlstereotype.cpp @@ -89,6 +89,10 @@ QT_BEGIN_NAMESPACE \brief A stereotype defines how an existing metaclass may be extended, and enables the use of platform or domain specific terminology or notation in place of, or in addition to, the ones used for the extended metaclass. */ + +/*! + Creates a new QUmlStereotype. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlStereotype::QUmlStereotype(bool createQModelingObject) : QUmlClass(false) { @@ -96,6 +100,9 @@ QUmlStereotype::QUmlStereotype(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlStereotypeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlStereotype. +*/ QModelingElement *QUmlStereotype::clone() const { QUmlStereotype *c = new QUmlStereotype; @@ -168,6 +175,10 @@ QModelingElement *QUmlStereotype::clone() const /*! Stereotype can change the graphical appearance of the extended model element by using attached icons. When this association is not null, it references the location of the icon content to be displayed within diagrams presenting the extended model elements. + + \sa addIcon(), removeIcon() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlImage *> QUmlStereotype::icons() const { @@ -176,6 +187,11 @@ const QSet<QUmlImage *> QUmlStereotype::icons() const return _icons; } +/*! + Adds \a icon to icons. + + \sa icons(), removeIcon() + */ void QUmlStereotype::addIcon(QUmlImage *icon) { // This is a read-write association end @@ -191,6 +207,11 @@ void QUmlStereotype::addIcon(QUmlImage *icon) } } +/*! + Removes \a icon from icons. + + \sa icons(), addIcon() + */ void QUmlStereotype::removeIcon(QUmlImage *icon) { // This is a read-write association end @@ -207,6 +228,8 @@ void QUmlStereotype::removeIcon(QUmlImage *icon) /*! The profile that directly or indirectly contains this stereotype. + + \b {This is a read-only derived property.} */ QUmlProfile *QUmlStereotype::profile() const { @@ -217,6 +240,9 @@ QUmlProfile *QUmlStereotype::profile() const return 0; } +/*! + Adjusts profile to \a profile. + */ void QUmlStereotype::setProfile(QUmlProfile *profile) { // This is a read-only derived association end diff --git a/src/uml/qumlstereotype.h b/src/uml/qumlstereotype.h index 1f3e5a68..08657e92 100644 --- a/src/uml/qumlstereotype.h +++ b/src/uml/qumlstereotype.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlClass> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -79,7 +77,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlStereotype) *) -QT_END_HEADER - #endif // QUMLSTEREOTYPE_H diff --git a/src/uml/qumlstringexpression.cpp b/src/uml/qumlstringexpression.cpp index 4263245e..5c04a1ae 100644 --- a/src/uml/qumlstringexpression.cpp +++ b/src/uml/qumlstringexpression.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief An expression that specifies a string value that is derived by concatenating a set of sub string expressions, some of which might be template parameters. */ + +/*! + Creates a new QUmlStringExpression. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlStringExpression::QUmlStringExpression(bool createQModelingObject) : QUmlExpression(false), _owningExpression(0) @@ -72,6 +76,9 @@ QUmlStringExpression::QUmlStringExpression(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlStringExpressionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlStringExpression. +*/ QModelingElement *QUmlStringExpression::clone() const { QUmlStringExpression *c = new QUmlStringExpression; @@ -107,6 +114,10 @@ QModelingElement *QUmlStringExpression::clone() const /*! The string expression of which this expression is a substring. + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlStringExpression::subExpressions(). */ QUmlStringExpression *QUmlStringExpression::owningExpression() const { @@ -115,6 +126,9 @@ QUmlStringExpression *QUmlStringExpression::owningExpression() const return _owningExpression; } +/*! + Adjusts owningExpression to \a owningExpression. + */ void QUmlStringExpression::setOwningExpression(QUmlStringExpression *owningExpression) { // This is a read-write association end @@ -133,6 +147,12 @@ void QUmlStringExpression::setOwningExpression(QUmlStringExpression *owningExpre /*! The StringExpressions that constitute this StringExpression. + + \sa addSubExpression(), removeSubExpression() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlStringExpression::owningExpression(). */ const QSet<QUmlStringExpression *> QUmlStringExpression::subExpressions() const { @@ -141,6 +161,11 @@ const QSet<QUmlStringExpression *> QUmlStringExpression::subExpressions() const return _subExpressions; } +/*! + Adds \a subExpression to subExpressions. + + \sa subExpressions(), removeSubExpression() + */ void QUmlStringExpression::addSubExpression(QUmlStringExpression *subExpression) { // This is a read-write association end @@ -161,6 +186,11 @@ void QUmlStringExpression::addSubExpression(QUmlStringExpression *subExpression) } } +/*! + Removes \a subExpression from subExpressions. + + \sa subExpressions(), addSubExpression() + */ void QUmlStringExpression::removeSubExpression(QUmlStringExpression *subExpression) { // This is a read-write association end diff --git a/src/uml/qumlstringexpression.h b/src/uml/qumlstringexpression.h index 1cc17c31..1c2a9514 100644 --- a/src/uml/qumlstringexpression.h +++ b/src/uml/qumlstringexpression.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlExpression> #include <QtUml/QUmlTemplateableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -78,7 +76,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlStringExpression) *) -QT_END_HEADER - #endif // QUMLSTRINGEXPRESSION_H diff --git a/src/uml/qumlstructuralfeature.cpp b/src/uml/qumlstructuralfeature.cpp index 3588a5eb..684f87f9 100644 --- a/src/uml/qumlstructuralfeature.cpp +++ b/src/uml/qumlstructuralfeature.cpp @@ -60,12 +60,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A structural feature is a typed feature of a classifier that specifies the structure of instances of the classifier.By specializing multiplicity element, it supports a multiplicity that specifies valid cardinalities for the collection of values associated with an instantiation of the structural feature. + + \b {QUmlStructuralFeature is an abstract class.} */ + +/*! + Creates a new QUmlStructuralFeature. +*/ QUmlStructuralFeature::QUmlStructuralFeature() : _isReadOnly(false) { } +/*! + Returns a deep-copied clone of the QUmlStructuralFeature. +*/ QModelingElement *QUmlStructuralFeature::clone() const { QUmlStructuralFeature *c = new QUmlStructuralFeature; @@ -103,6 +112,9 @@ bool QUmlStructuralFeature::isReadOnly() const return _isReadOnly; } +/*! + Adjusts isReadOnly to \a isReadOnly. + */ void QUmlStructuralFeature::setReadOnly(bool isReadOnly) { // This is a read-write property diff --git a/src/uml/qumlstructuralfeature.h b/src/uml/qumlstructuralfeature.h index d4db0447..e879c887 100644 --- a/src/uml/qumlstructuralfeature.h +++ b/src/uml/qumlstructuralfeature.h @@ -47,8 +47,6 @@ #include <QtUml/QUmlMultiplicityElement> #include <QtUml/QUmlFeature> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlStructuralFeature) *) -QT_END_HEADER - #endif // QUMLSTRUCTURALFEATURE_H diff --git a/src/uml/qumlstructuralfeatureaction.cpp b/src/uml/qumlstructuralfeatureaction.cpp index d8349403..9be62657 100644 --- a/src/uml/qumlstructuralfeatureaction.cpp +++ b/src/uml/qumlstructuralfeatureaction.cpp @@ -70,13 +70,22 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief StructuralFeatureAction is an abstract class for all structural feature actions. + + \b {QUmlStructuralFeatureAction is an abstract class.} */ + +/*! + Creates a new QUmlStructuralFeatureAction. +*/ QUmlStructuralFeatureAction::QUmlStructuralFeatureAction() : _object(0), _structuralFeature(0) { } +/*! + Returns a deep-copied clone of the QUmlStructuralFeatureAction. +*/ QModelingElement *QUmlStructuralFeatureAction::clone() const { QUmlStructuralFeatureAction *c = new QUmlStructuralFeatureAction; @@ -121,6 +130,8 @@ QModelingElement *QUmlStructuralFeatureAction::clone() const /*! Gives the input pin from which the object whose structural feature is to be read or written is obtained. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlStructuralFeatureAction::object() const { @@ -129,6 +140,9 @@ QUmlInputPin *QUmlStructuralFeatureAction::object() const return _object; } +/*! + Adjusts object to \a object. + */ void QUmlStructuralFeatureAction::setObject(QUmlInputPin *object) { // This is a read-write association end @@ -159,6 +173,9 @@ QUmlStructuralFeature *QUmlStructuralFeatureAction::structuralFeature() const return _structuralFeature; } +/*! + Adjusts structuralFeature to \a structuralFeature. + */ void QUmlStructuralFeatureAction::setStructuralFeature(QUmlStructuralFeature *structuralFeature) { // This is a read-write association end diff --git a/src/uml/qumlstructuralfeatureaction.h b/src/uml/qumlstructuralfeatureaction.h index 272b84f7..e5400765 100644 --- a/src/uml/qumlstructuralfeatureaction.h +++ b/src/uml/qumlstructuralfeatureaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlStructuralFeatureAction) *) -QT_END_HEADER - #endif // QUMLSTRUCTURALFEATUREACTION_H diff --git a/src/uml/qumlstructuredactivitynode.cpp b/src/uml/qumlstructuredactivitynode.cpp index 79ff3c75..c7c08e45 100644 --- a/src/uml/qumlstructuredactivitynode.cpp +++ b/src/uml/qumlstructuredactivitynode.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A structured activity node is an executable activity node that may have an expansion into subordinate nodes as an activity group. The subordinate nodes must belong to only one structured activity node, although they may be nested.Because of the concurrent nature of the execution of actions within and across activities, it can be difficult to guarantee the consistent access and modification of object memory. In order to avoid race conditions or other concurrency-related problems, it is sometimes necessary to isolate the effects of a group of actions from the effects of actions outside the group. This may be indicated by setting the mustIsolate attribute to true on a structured activity node. If a structured activity node is "isolated," then any object used by an action within the node cannot be accessed by any action outside the node until the structured activity node as a whole completes. Any concurrent actions that would result in accessing such objects are required to have their execution deferred until the completion of the node. */ + +/*! + Creates a new QUmlStructuredActivityNode. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlStructuredActivityNode::QUmlStructuredActivityNode(bool createQModelingObject) : _activity(0), _mustIsolate(false) @@ -81,6 +85,9 @@ QUmlStructuredActivityNode::QUmlStructuredActivityNode(bool createQModelingObjec _qModelingObject = qobject_cast<QModelingObject *>(new QUmlStructuredActivityNodeObject(this)); } +/*! + Returns a deep-copied clone of the QUmlStructuredActivityNode. +*/ QModelingElement *QUmlStructuredActivityNode::clone() const { QUmlStructuredActivityNode *c = new QUmlStructuredActivityNode; @@ -138,6 +145,10 @@ QModelingElement *QUmlStructuredActivityNode::clone() const /*! Activity immediately containing the node. + + \b {Redefined property(ies):} QUmlActivityGroup::inActivity(), QUmlActivityNode::activity(). + + \b {Opposite property(ies):} QUmlActivity::structuredNodes(). */ QUmlActivity *QUmlStructuredActivityNode::activity() const { @@ -146,6 +157,9 @@ QUmlActivity *QUmlStructuredActivityNode::activity() const return _activity; } +/*! + Adjusts activity to \a activity. + */ void QUmlStructuredActivityNode::setActivity(QUmlActivity *activity) { // This is a read-write association end @@ -163,6 +177,12 @@ void QUmlStructuredActivityNode::setActivity(QUmlActivity *activity) /*! Edges immediately contained in the structured node. + + \sa addEdge(), removeEdge() + + \b {Subsetted property(ies):} QUmlActivityGroup::containedEdges(), QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlActivityEdge::inStructuredNode(). */ const QSet<QUmlActivityEdge *> QUmlStructuredActivityNode::edges() const { @@ -171,6 +191,11 @@ const QSet<QUmlActivityEdge *> QUmlStructuredActivityNode::edges() const return _edges; } +/*! + Adds \a edge to edges. + + \sa edges(), removeEdge() + */ void QUmlStructuredActivityNode::addEdge(QUmlActivityEdge *edge) { // This is a read-write association end @@ -192,6 +217,11 @@ void QUmlStructuredActivityNode::addEdge(QUmlActivityEdge *edge) } } +/*! + Removes \a edge from edges. + + \sa edges(), addEdge() + */ void QUmlStructuredActivityNode::removeEdge(QUmlActivityEdge *edge) { // This is a read-write association end @@ -222,6 +252,9 @@ bool QUmlStructuredActivityNode::mustIsolate() const return _mustIsolate; } +/*! + Adjusts mustIsolate to \a mustIsolate. + */ void QUmlStructuredActivityNode::setMustIsolate(bool mustIsolate) { // This is a read-write property @@ -234,6 +267,12 @@ void QUmlStructuredActivityNode::setMustIsolate(bool mustIsolate) /*! Nodes immediately contained in the group. + + \sa addNode(), removeNode() + + \b {Subsetted property(ies):} QUmlActivityGroup::containedNodes(), QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlActivityNode::inStructuredNode(). */ const QSet<QUmlActivityNode *> QUmlStructuredActivityNode::nodes() const { @@ -242,6 +281,11 @@ const QSet<QUmlActivityNode *> QUmlStructuredActivityNode::nodes() const return _nodes; } +/*! + Adds \a node to nodes. + + \sa nodes(), removeNode() + */ void QUmlStructuredActivityNode::addNode(QUmlActivityNode *node) { // This is a read-write association end @@ -263,6 +307,11 @@ void QUmlStructuredActivityNode::addNode(QUmlActivityNode *node) } } +/*! + Removes \a node from nodes. + + \sa nodes(), addNode() + */ void QUmlStructuredActivityNode::removeNode(QUmlActivityNode *node) { // This is a read-write association end @@ -283,14 +332,12 @@ void QUmlStructuredActivityNode::removeNode(QUmlActivityNode *node) } } - const QSet<QUmlInputPin *> QUmlStructuredActivityNode::structuredNodeInputs() const { // This is a read-write association end return _structuredNodeInputs; } - void QUmlStructuredActivityNode::addStructuredNodeInput(QUmlInputPin *structuredNodeInput) { // This is a read-write association end @@ -305,7 +352,6 @@ void QUmlStructuredActivityNode::addStructuredNodeInput(QUmlInputPin *structured addInput(structuredNodeInput); } } - void QUmlStructuredActivityNode::removeStructuredNodeInput(QUmlInputPin *structuredNodeInput) { // This is a read-write association end @@ -320,14 +366,12 @@ void QUmlStructuredActivityNode::removeStructuredNodeInput(QUmlInputPin *structu } } - const QSet<QUmlOutputPin *> QUmlStructuredActivityNode::structuredNodeOutputs() const { // This is a read-write association end return _structuredNodeOutputs; } - void QUmlStructuredActivityNode::addStructuredNodeOutput(QUmlOutputPin *structuredNodeOutput) { // This is a read-write association end @@ -342,7 +386,6 @@ void QUmlStructuredActivityNode::addStructuredNodeOutput(QUmlOutputPin *structur addOutput(structuredNodeOutput); } } - void QUmlStructuredActivityNode::removeStructuredNodeOutput(QUmlOutputPin *structuredNodeOutput) { // This is a read-write association end @@ -359,6 +402,12 @@ void QUmlStructuredActivityNode::removeStructuredNodeOutput(QUmlOutputPin *struc /*! A variable defined in the scope of the structured activity node. It has no value and may not be accessed + + \sa addVariable(), removeVariable() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlVariable::scope(). */ const QSet<QUmlVariable *> QUmlStructuredActivityNode::variables() const { @@ -367,6 +416,11 @@ const QSet<QUmlVariable *> QUmlStructuredActivityNode::variables() const return _variables; } +/*! + Adds \a variable to variables. + + \sa variables(), removeVariable() + */ void QUmlStructuredActivityNode::addVariable(QUmlVariable *variable) { // This is a read-write association end @@ -387,6 +441,11 @@ void QUmlStructuredActivityNode::addVariable(QUmlVariable *variable) } } +/*! + Removes \a variable from variables. + + \sa variables(), addVariable() + */ void QUmlStructuredActivityNode::removeVariable(QUmlVariable *variable) { // This is a read-write association end diff --git a/src/uml/qumlstructuredactivitynode.h b/src/uml/qumlstructuredactivitynode.h index b6dec5a9..ff61f610 100644 --- a/src/uml/qumlstructuredactivitynode.h +++ b/src/uml/qumlstructuredactivitynode.h @@ -47,8 +47,6 @@ #include <QtUml/QUmlNamespace> #include <QtUml/QUmlActivityGroup> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -102,7 +100,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlStructuredActivityNode) *) -QT_END_HEADER - #endif // QUMLSTRUCTUREDACTIVITYNODE_H diff --git a/src/uml/qumlstructuredclassifier.cpp b/src/uml/qumlstructuredclassifier.cpp index 8a17169c..901bb3e1 100644 --- a/src/uml/qumlstructuredclassifier.cpp +++ b/src/uml/qumlstructuredclassifier.cpp @@ -77,11 +77,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A structured classifier is an abstract metaclass that represents any classifier whose behavior can be fully or partly described by the collaboration of owned or referenced instances. + + \b {QUmlStructuredClassifier is an abstract class.} */ + +/*! + Creates a new QUmlStructuredClassifier. +*/ QUmlStructuredClassifier::QUmlStructuredClassifier() { } +/*! + Returns a deep-copied clone of the QUmlStructuredClassifier. +*/ QModelingElement *QUmlStructuredClassifier::clone() const { QUmlStructuredClassifier *c = new QUmlStructuredClassifier; @@ -139,6 +148,10 @@ QModelingElement *QUmlStructuredClassifier::clone() const /*! References the properties owned by the classifier. + + \sa addOwnedAttribute(), removeOwnedAttribute() + + \b {Subsetted property(ies):} QUmlClassifier::attributes(), QUmlNamespace::ownedMembers(), QUmlStructuredClassifier::roles(). */ const QList<QUmlProperty *> QUmlStructuredClassifier::ownedAttributes() const { @@ -147,6 +160,11 @@ const QList<QUmlProperty *> QUmlStructuredClassifier::ownedAttributes() const return _ownedAttributes; } +/*! + Adds \a ownedAttribute to ownedAttributes. + + \sa ownedAttributes(), removeOwnedAttribute() + */ void QUmlStructuredClassifier::addOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end @@ -164,6 +182,11 @@ void QUmlStructuredClassifier::addOwnedAttribute(QUmlProperty *ownedAttribute) } } +/*! + Removes \a ownedAttribute from ownedAttributes. + + \sa ownedAttributes(), addOwnedAttribute() + */ void QUmlStructuredClassifier::removeOwnedAttribute(QUmlProperty *ownedAttribute) { // This is a read-write association end @@ -182,6 +205,10 @@ void QUmlStructuredClassifier::removeOwnedAttribute(QUmlProperty *ownedAttribute /*! References the connectors owned by the classifier. + + \sa addOwnedConnector(), removeOwnedConnector() + + \b {Subsetted property(ies):} QUmlClassifier::features(), QUmlNamespace::ownedMembers(). */ const QSet<QUmlConnector *> QUmlStructuredClassifier::ownedConnectors() const { @@ -190,6 +217,11 @@ const QSet<QUmlConnector *> QUmlStructuredClassifier::ownedConnectors() const return _ownedConnectors; } +/*! + Adds \a ownedConnector to ownedConnectors. + + \sa ownedConnectors(), removeOwnedConnector() + */ void QUmlStructuredClassifier::addOwnedConnector(QUmlConnector *ownedConnector) { // This is a read-write association end @@ -206,6 +238,11 @@ void QUmlStructuredClassifier::addOwnedConnector(QUmlConnector *ownedConnector) } } +/*! + Removes \a ownedConnector from ownedConnectors. + + \sa ownedConnectors(), addOwnedConnector() + */ void QUmlStructuredClassifier::removeOwnedConnector(QUmlConnector *ownedConnector) { // This is a read-write association end @@ -223,6 +260,8 @@ void QUmlStructuredClassifier::removeOwnedConnector(QUmlConnector *ownedConnecto /*! References the properties specifying instances that the classifier owns by composition. This association is derived, selecting those owned properties where isComposite is true. + + \b {This is a read-only derived property.} */ const QSet<QUmlProperty *> QUmlStructuredClassifier::parts() const { @@ -237,6 +276,11 @@ const QSet<QUmlProperty *> QUmlStructuredClassifier::parts() const return parts_; } +/*! + Adds \a part to parts. + + \sa parts(), removePart() + */ void QUmlStructuredClassifier::addPart(QUmlProperty *part) { // This is a read-only derived association end @@ -249,6 +293,11 @@ void QUmlStructuredClassifier::addPart(QUmlProperty *part) } } +/*! + Removes \a part from parts. + + \sa parts(), addPart() + */ void QUmlStructuredClassifier::removePart(QUmlProperty *part) { // This is a read-only derived association end @@ -263,6 +312,10 @@ void QUmlStructuredClassifier::removePart(QUmlProperty *part) /*! References the roles that instances may play in this classifier. + + \b {This is a read-only derived union property.} + + \b {Subsetted property(ies):} QUmlNamespace::members(). */ const QSet<QUmlConnectableElement *> QUmlStructuredClassifier::roles() const { @@ -271,6 +324,11 @@ const QSet<QUmlConnectableElement *> QUmlStructuredClassifier::roles() const return _roles; } +/*! + Adds \a role to roles. + + \sa roles(), removeRole() + */ void QUmlStructuredClassifier::addRole(QUmlConnectableElement *role) { // This is a read-only derived union association end @@ -285,6 +343,11 @@ void QUmlStructuredClassifier::addRole(QUmlConnectableElement *role) } } +/*! + Removes \a role from roles. + + \sa roles(), addRole() + */ void QUmlStructuredClassifier::removeRole(QUmlConnectableElement *role) { // This is a read-only derived union association end diff --git a/src/uml/qumlstructuredclassifier.h b/src/uml/qumlstructuredclassifier.h index f2226f63..538cb368 100644 --- a/src/uml/qumlstructuredclassifier.h +++ b/src/uml/qumlstructuredclassifier.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -86,7 +84,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlStructuredClassifier) *) -QT_END_HEADER - #endif // QUMLSTRUCTUREDCLASSIFIER_H diff --git a/src/uml/qumlsubstitution.cpp b/src/uml/qumlsubstitution.cpp index 42a4567c..644ffcac 100644 --- a/src/uml/qumlsubstitution.cpp +++ b/src/uml/qumlsubstitution.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief A substitution is a relationship between two classifiers signifies that the substituting classifier complies with the contract specified by the contract classifier. This implies that instances of the substituting classifier are runtime substitutable where instances of the contract classifier are expected. */ + +/*! + Creates a new QUmlSubstitution. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlSubstitution::QUmlSubstitution(bool createQModelingObject) : QUmlRealization(false), _contract(0), @@ -72,6 +76,9 @@ QUmlSubstitution::QUmlSubstitution(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlSubstitutionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlSubstitution. +*/ QModelingElement *QUmlSubstitution::clone() const { QUmlSubstitution *c = new QUmlSubstitution; @@ -104,6 +111,8 @@ QModelingElement *QUmlSubstitution::clone() const /*! The contract with which the substituting classifier complies. + + \b {Subsetted property(ies):} QUmlDependency::suppliers(). */ QUmlClassifier *QUmlSubstitution::contract() const { @@ -112,6 +121,9 @@ QUmlClassifier *QUmlSubstitution::contract() const return _contract; } +/*! + Adjusts contract to \a contract. + */ void QUmlSubstitution::setContract(QUmlClassifier *contract) { // This is a read-write association end @@ -133,6 +145,10 @@ void QUmlSubstitution::setContract(QUmlClassifier *contract) /*! Instances of the substituting classifier are runtime substitutable where instances of the contract classifier are expected. + + \b {Subsetted property(ies):} QUmlElement::owner(), QUmlDependency::clients(). + + \b {Opposite property(ies):} QUmlClassifier::substitutions(). */ QUmlClassifier *QUmlSubstitution::substitutingClassifier() const { @@ -141,6 +157,9 @@ QUmlClassifier *QUmlSubstitution::substitutingClassifier() const return _substitutingClassifier; } +/*! + Adjusts substitutingClassifier to \a substitutingClassifier. + */ void QUmlSubstitution::setSubstitutingClassifier(QUmlClassifier *substitutingClassifier) { // This is a read-write association end diff --git a/src/uml/qumlsubstitution.h b/src/uml/qumlsubstitution.h index c4398116..fc369ce0 100644 --- a/src/uml/qumlsubstitution.h +++ b/src/uml/qumlsubstitution.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlRealization> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlSubstitution) *) -QT_END_HEADER - #endif // QUMLSUBSTITUTION_H diff --git a/src/uml/qumltemplateableelement.cpp b/src/uml/qumltemplateableelement.cpp index b1019df9..3dd204da 100644 --- a/src/uml/qumltemplateableelement.cpp +++ b/src/uml/qumltemplateableelement.cpp @@ -53,12 +53,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A templateable element is an element that can optionally be defined as a template and bound to other templates. + + \b {QUmlTemplateableElement is an abstract class.} */ + +/*! + Creates a new QUmlTemplateableElement. +*/ QUmlTemplateableElement::QUmlTemplateableElement() : _ownedTemplateSignature(0) { } +/*! + Returns a deep-copied clone of the QUmlTemplateableElement. +*/ QModelingElement *QUmlTemplateableElement::clone() const { QUmlTemplateableElement *c = new QUmlTemplateableElement; @@ -75,6 +84,10 @@ QModelingElement *QUmlTemplateableElement::clone() const /*! The optional template signature specifying the formal template parameters. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlTemplateSignature::template_(). */ QUmlTemplateSignature *QUmlTemplateableElement::ownedTemplateSignature() const { @@ -83,6 +96,9 @@ QUmlTemplateSignature *QUmlTemplateableElement::ownedTemplateSignature() const return _ownedTemplateSignature; } +/*! + Adjusts ownedTemplateSignature to \a ownedTemplateSignature. + */ void QUmlTemplateableElement::setOwnedTemplateSignature(QUmlTemplateSignature *ownedTemplateSignature) { // This is a read-write association end @@ -105,6 +121,12 @@ void QUmlTemplateableElement::setOwnedTemplateSignature(QUmlTemplateSignature *o /*! The optional bindings from this element to templates. + + \sa addTemplateBinding(), removeTemplateBinding() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlTemplateBinding::boundElement(). */ const QSet<QUmlTemplateBinding *> QUmlTemplateableElement::templateBindings() const { @@ -113,6 +135,11 @@ const QSet<QUmlTemplateBinding *> QUmlTemplateableElement::templateBindings() co return _templateBindings; } +/*! + Adds \a templateBinding to templateBindings. + + \sa templateBindings(), removeTemplateBinding() + */ void QUmlTemplateableElement::addTemplateBinding(QUmlTemplateBinding *templateBinding) { // This is a read-write association end @@ -133,6 +160,11 @@ void QUmlTemplateableElement::addTemplateBinding(QUmlTemplateBinding *templateBi } } +/*! + Removes \a templateBinding from templateBindings. + + \sa templateBindings(), addTemplateBinding() + */ void QUmlTemplateableElement::removeTemplateBinding(QUmlTemplateBinding *templateBinding) { // This is a read-write association end diff --git a/src/uml/qumltemplateableelement.h b/src/uml/qumltemplateableelement.h index bb7af122..8e755245 100644 --- a/src/uml/qumltemplateableelement.h +++ b/src/uml/qumltemplateableelement.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -82,7 +80,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTemplateableElement) *) -QT_END_HEADER - #endif // QUMLTEMPLATEABLEELEMENT_H diff --git a/src/uml/qumltemplatebinding.cpp b/src/uml/qumltemplatebinding.cpp index 2dd73185..0c82b305 100644 --- a/src/uml/qumltemplatebinding.cpp +++ b/src/uml/qumltemplatebinding.cpp @@ -57,6 +57,10 @@ QT_BEGIN_NAMESPACE \brief A template binding represents a relationship between a templateable element and a template. A template binding specifies the substitutions of actual parameters for the formal parameters of the template. */ + +/*! + Creates a new QUmlTemplateBinding. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTemplateBinding::QUmlTemplateBinding(bool createQModelingObject) : _boundElement(0), _signature(0) @@ -65,6 +69,9 @@ QUmlTemplateBinding::QUmlTemplateBinding(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTemplateBindingObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTemplateBinding. +*/ QModelingElement *QUmlTemplateBinding::clone() const { QUmlTemplateBinding *c = new QUmlTemplateBinding; @@ -83,6 +90,10 @@ QModelingElement *QUmlTemplateBinding::clone() const /*! The element that is bound by this binding. + + \b {Subsetted property(ies):} QUmlElement::owner(), QUmlDirectedRelationship::sources(). + + \b {Opposite property(ies):} QUmlTemplateableElement::templateBindings(). */ QUmlTemplateableElement *QUmlTemplateBinding::boundElement() const { @@ -91,6 +102,9 @@ QUmlTemplateableElement *QUmlTemplateBinding::boundElement() const return _boundElement; } +/*! + Adjusts boundElement to \a boundElement. + */ void QUmlTemplateBinding::setBoundElement(QUmlTemplateableElement *boundElement) { // This is a read-write association end @@ -113,6 +127,12 @@ void QUmlTemplateBinding::setBoundElement(QUmlTemplateableElement *boundElement) /*! The parameter substitutions owned by this template binding. + + \sa addParameterSubstitution(), removeParameterSubstitution() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlTemplateParameterSubstitution::templateBinding(). */ const QSet<QUmlTemplateParameterSubstitution *> QUmlTemplateBinding::parameterSubstitutions() const { @@ -121,6 +141,11 @@ const QSet<QUmlTemplateParameterSubstitution *> QUmlTemplateBinding::parameterSu return _parameterSubstitutions; } +/*! + Adds \a parameterSubstitution to parameterSubstitutions. + + \sa parameterSubstitutions(), removeParameterSubstitution() + */ void QUmlTemplateBinding::addParameterSubstitution(QUmlTemplateParameterSubstitution *parameterSubstitution) { // This is a read-write association end @@ -141,6 +166,11 @@ void QUmlTemplateBinding::addParameterSubstitution(QUmlTemplateParameterSubstitu } } +/*! + Removes \a parameterSubstitution from parameterSubstitutions. + + \sa parameterSubstitutions(), addParameterSubstitution() + */ void QUmlTemplateBinding::removeParameterSubstitution(QUmlTemplateParameterSubstitution *parameterSubstitution) { // This is a read-write association end @@ -162,6 +192,8 @@ void QUmlTemplateBinding::removeParameterSubstitution(QUmlTemplateParameterSubst /*! The template signature for the template that is the target of the binding. + + \b {Subsetted property(ies):} QUmlDirectedRelationship::targets(). */ QUmlTemplateSignature *QUmlTemplateBinding::signature() const { @@ -170,6 +202,9 @@ QUmlTemplateSignature *QUmlTemplateBinding::signature() const return _signature; } +/*! + Adjusts signature to \a signature. + */ void QUmlTemplateBinding::setSignature(QUmlTemplateSignature *signature) { // This is a read-write association end diff --git a/src/uml/qumltemplatebinding.h b/src/uml/qumltemplatebinding.h index 1c09265a..8e10c423 100644 --- a/src/uml/qumltemplatebinding.h +++ b/src/uml/qumltemplatebinding.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlDirectedRelationship> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTemplateBinding) *) -QT_END_HEADER - #endif // QUMLTEMPLATEBINDING_H diff --git a/src/uml/qumltemplateparameter.cpp b/src/uml/qumltemplateparameter.cpp index fc1eee18..3200efb9 100644 --- a/src/uml/qumltemplateparameter.cpp +++ b/src/uml/qumltemplateparameter.cpp @@ -55,6 +55,10 @@ QT_BEGIN_NAMESPACE \brief A template parameter exposes a parameterable element as a formal template parameter of a template. */ + +/*! + Creates a new QUmlTemplateParameter. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTemplateParameter::QUmlTemplateParameter(bool createQModelingObject) : _default_(0), _ownedDefault(0), @@ -66,6 +70,9 @@ QUmlTemplateParameter::QUmlTemplateParameter(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTemplateParameterObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTemplateParameter. +*/ QModelingElement *QUmlTemplateParameter::clone() const { QUmlTemplateParameter *c = new QUmlTemplateParameter; @@ -96,6 +103,9 @@ QUmlParameterableElement *QUmlTemplateParameter::default_() const return _default_; } +/*! + Adjusts default_ to \a default_. + */ void QUmlTemplateParameter::setDefault(QUmlParameterableElement *default_) { // This is a read-write association end @@ -109,6 +119,8 @@ void QUmlTemplateParameter::setDefault(QUmlParameterableElement *default_) /*! The element that is owned by this template parameter for the purpose of providing a default. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(), QUmlTemplateParameter::default_(). */ QUmlParameterableElement *QUmlTemplateParameter::ownedDefault() const { @@ -117,6 +129,9 @@ QUmlParameterableElement *QUmlTemplateParameter::ownedDefault() const return _ownedDefault; } +/*! + Adjusts ownedDefault to \a ownedDefault. + */ void QUmlTemplateParameter::setOwnedDefault(QUmlParameterableElement *ownedDefault) { // This is a read-write association end @@ -140,6 +155,10 @@ void QUmlTemplateParameter::setOwnedDefault(QUmlParameterableElement *ownedDefau /*! The element that is owned by this template parameter. + + \b {Subsetted property(ies):} QUmlTemplateParameter::parameteredElement(), QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlParameterableElement::owningTemplateParameter(). */ QUmlParameterableElement *QUmlTemplateParameter::ownedParameteredElement() const { @@ -148,6 +167,9 @@ QUmlParameterableElement *QUmlTemplateParameter::ownedParameteredElement() const return _ownedParameteredElement; } +/*! + Adjusts ownedParameteredElement to \a ownedParameteredElement. + */ void QUmlTemplateParameter::setOwnedParameteredElement(QUmlParameterableElement *ownedParameteredElement) { // This is a read-write association end @@ -171,6 +193,8 @@ void QUmlTemplateParameter::setOwnedParameteredElement(QUmlParameterableElement /*! The element exposed by this template parameter. + + \b {Opposite property(ies):} QUmlParameterableElement::templateParameter(). */ QUmlParameterableElement *QUmlTemplateParameter::parameteredElement() const { @@ -179,6 +203,9 @@ QUmlParameterableElement *QUmlTemplateParameter::parameteredElement() const return _parameteredElement; } +/*! + Adjusts parameteredElement to \a parameteredElement. + */ void QUmlTemplateParameter::setParameteredElement(QUmlParameterableElement *parameteredElement) { // This is a read-write association end @@ -192,6 +219,10 @@ void QUmlTemplateParameter::setParameteredElement(QUmlParameterableElement *para /*! The template signature that owns this template parameter. + + \b {Subsetted property(ies):} QUmlElement::owner(), . + + \b {Opposite property(ies):} QUmlTemplateSignature::ownedParameters(). */ QUmlTemplateSignature *QUmlTemplateParameter::signature() const { @@ -200,6 +231,9 @@ QUmlTemplateSignature *QUmlTemplateParameter::signature() const return _signature; } +/*! + Adjusts signature to \a signature. + */ void QUmlTemplateParameter::setSignature(QUmlTemplateSignature *signature) { // This is a read-write association end diff --git a/src/uml/qumltemplateparameter.h b/src/uml/qumltemplateparameter.h index 69e2aef0..adc21de5 100644 --- a/src/uml/qumltemplateparameter.h +++ b/src/uml/qumltemplateparameter.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -85,7 +83,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTemplateParameter) *) -QT_END_HEADER - #endif // QUMLTEMPLATEPARAMETER_H diff --git a/src/uml/qumltemplateparametersubstitution.cpp b/src/uml/qumltemplateparametersubstitution.cpp index 99c17612..131f91fb 100644 --- a/src/uml/qumltemplateparametersubstitution.cpp +++ b/src/uml/qumltemplateparametersubstitution.cpp @@ -56,6 +56,10 @@ QT_BEGIN_NAMESPACE \brief A template parameter substitution relates the actual parameter to a formal template parameter as part of a template binding. */ + +/*! + Creates a new QUmlTemplateParameterSubstitution. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTemplateParameterSubstitution::QUmlTemplateParameterSubstitution(bool createQModelingObject) : _actual(0), _formal(0), @@ -66,6 +70,9 @@ QUmlTemplateParameterSubstitution::QUmlTemplateParameterSubstitution(bool create _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTemplateParameterSubstitutionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTemplateParameterSubstitution. +*/ QModelingElement *QUmlTemplateParameterSubstitution::clone() const { QUmlTemplateParameterSubstitution *c = new QUmlTemplateParameterSubstitution; @@ -94,6 +101,9 @@ QUmlParameterableElement *QUmlTemplateParameterSubstitution::actual() const return _actual; } +/*! + Adjusts actual to \a actual. + */ void QUmlTemplateParameterSubstitution::setActual(QUmlParameterableElement *actual) { // This is a read-write association end @@ -115,6 +125,9 @@ QUmlTemplateParameter *QUmlTemplateParameterSubstitution::formal() const return _formal; } +/*! + Adjusts formal to \a formal. + */ void QUmlTemplateParameterSubstitution::setFormal(QUmlTemplateParameter *formal) { // This is a read-write association end @@ -128,6 +141,8 @@ void QUmlTemplateParameterSubstitution::setFormal(QUmlTemplateParameter *formal) /*! The actual parameter that is owned by this substitution. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(), QUmlTemplateParameterSubstitution::actual(). */ QUmlParameterableElement *QUmlTemplateParameterSubstitution::ownedActual() const { @@ -136,6 +151,9 @@ QUmlParameterableElement *QUmlTemplateParameterSubstitution::ownedActual() const return _ownedActual; } +/*! + Adjusts ownedActual to \a ownedActual. + */ void QUmlTemplateParameterSubstitution::setOwnedActual(QUmlParameterableElement *ownedActual) { // This is a read-write association end @@ -159,6 +177,10 @@ void QUmlTemplateParameterSubstitution::setOwnedActual(QUmlParameterableElement /*! The optional bindings from this element to templates. + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlTemplateBinding::parameterSubstitutions(). */ QUmlTemplateBinding *QUmlTemplateParameterSubstitution::templateBinding() const { @@ -167,6 +189,9 @@ QUmlTemplateBinding *QUmlTemplateParameterSubstitution::templateBinding() const return _templateBinding; } +/*! + Adjusts templateBinding to \a templateBinding. + */ void QUmlTemplateParameterSubstitution::setTemplateBinding(QUmlTemplateBinding *templateBinding) { // This is a read-write association end diff --git a/src/uml/qumltemplateparametersubstitution.h b/src/uml/qumltemplateparametersubstitution.h index f26fe85a..5f04f7f7 100644 --- a/src/uml/qumltemplateparametersubstitution.h +++ b/src/uml/qumltemplateparametersubstitution.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -83,7 +81,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTemplateParameterSubstitution) *) -QT_END_HEADER - #endif // QUMLTEMPLATEPARAMETERSUBSTITUTION_H diff --git a/src/uml/qumltemplatesignature.cpp b/src/uml/qumltemplatesignature.cpp index 10f1ad02..cff29728 100644 --- a/src/uml/qumltemplatesignature.cpp +++ b/src/uml/qumltemplatesignature.cpp @@ -55,6 +55,10 @@ QT_BEGIN_NAMESPACE \brief A template signature bundles the set of formal template parameters for a templated element. */ + +/*! + Creates a new QUmlTemplateSignature. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTemplateSignature::QUmlTemplateSignature(bool createQModelingObject) : _template_(0) { @@ -62,6 +66,9 @@ QUmlTemplateSignature::QUmlTemplateSignature(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTemplateSignatureObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTemplateSignature. +*/ QModelingElement *QUmlTemplateSignature::clone() const { QUmlTemplateSignature *c = new QUmlTemplateSignature; @@ -80,6 +87,12 @@ QModelingElement *QUmlTemplateSignature::clone() const /*! The formal template parameters that are owned by this template signature. + + \sa addOwnedParameter(), removeOwnedParameter() + + \b {Subsetted property(ies):} QUmlTemplateSignature::parameters(), QUmlElement::ownedElements(). + + \b {Opposite property(ies):} QUmlTemplateParameter::signature(). */ const QList<QUmlTemplateParameter *> QUmlTemplateSignature::ownedParameters() const { @@ -88,6 +101,11 @@ const QList<QUmlTemplateParameter *> QUmlTemplateSignature::ownedParameters() co return _ownedParameters; } +/*! + Adds \a ownedParameter to ownedParameters. + + \sa ownedParameters(), removeOwnedParameter() + */ void QUmlTemplateSignature::addOwnedParameter(QUmlTemplateParameter *ownedParameter) { // This is a read-write association end @@ -109,6 +127,11 @@ void QUmlTemplateSignature::addOwnedParameter(QUmlTemplateParameter *ownedParame } } +/*! + Removes \a ownedParameter from ownedParameters. + + \sa ownedParameters(), addOwnedParameter() + */ void QUmlTemplateSignature::removeOwnedParameter(QUmlTemplateParameter *ownedParameter) { // This is a read-write association end @@ -131,6 +154,8 @@ void QUmlTemplateSignature::removeOwnedParameter(QUmlTemplateParameter *ownedPar /*! The ordered set of all formal template parameters for this template signature. + + \sa addParameter(), removeParameter() */ const QList<QUmlTemplateParameter *> QUmlTemplateSignature::parameters() const { @@ -139,6 +164,11 @@ const QList<QUmlTemplateParameter *> QUmlTemplateSignature::parameters() const return _parameters; } +/*! + Adds \a parameter to parameters. + + \sa parameters(), removeParameter() + */ void QUmlTemplateSignature::addParameter(QUmlTemplateParameter *parameter) { // This is a read-write association end @@ -150,6 +180,11 @@ void QUmlTemplateSignature::addParameter(QUmlTemplateParameter *parameter) } } +/*! + Removes \a parameter from parameters. + + \sa parameters(), addParameter() + */ void QUmlTemplateSignature::removeParameter(QUmlTemplateParameter *parameter) { // This is a read-write association end @@ -161,6 +196,10 @@ void QUmlTemplateSignature::removeParameter(QUmlTemplateParameter *parameter) /*! The element that owns this template signature. + + \b {Subsetted property(ies):} QUmlElement::owner(). + + \b {Opposite property(ies):} QUmlTemplateableElement::ownedTemplateSignature(). */ QUmlTemplateableElement *QUmlTemplateSignature::template_() const { @@ -169,6 +208,9 @@ QUmlTemplateableElement *QUmlTemplateSignature::template_() const return _template_; } +/*! + Adjusts template_ to \a template_. + */ void QUmlTemplateSignature::setTemplate(QUmlTemplateableElement *template_) { // This is a read-write association end diff --git a/src/uml/qumltemplatesignature.h b/src/uml/qumltemplatesignature.h index 31f8565c..935d4ade 100644 --- a/src/uml/qumltemplatesignature.h +++ b/src/uml/qumltemplatesignature.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTemplateSignature) *) -QT_END_HEADER - #endif // QUMLTEMPLATESIGNATURE_H diff --git a/src/uml/qumltestidentityaction.cpp b/src/uml/qumltestidentityaction.cpp index 4552583e..72def356 100644 --- a/src/uml/qumltestidentityaction.cpp +++ b/src/uml/qumltestidentityaction.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief A test identity action is an action that tests if two values are identical objects. */ + +/*! + Creates a new QUmlTestIdentityAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTestIdentityAction::QUmlTestIdentityAction(bool createQModelingObject) : _first(0), _result(0), @@ -81,6 +85,9 @@ QUmlTestIdentityAction::QUmlTestIdentityAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTestIdentityActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTestIdentityAction. +*/ QModelingElement *QUmlTestIdentityAction::clone() const { QUmlTestIdentityAction *c = new QUmlTestIdentityAction; @@ -127,6 +134,8 @@ QModelingElement *QUmlTestIdentityAction::clone() const /*! Gives the pin on which an object is placed. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlTestIdentityAction::first() const { @@ -135,6 +144,9 @@ QUmlInputPin *QUmlTestIdentityAction::first() const return _first; } +/*! + Adjusts first to \a first. + */ void QUmlTestIdentityAction::setFirst(QUmlInputPin *first) { // This is a read-write association end @@ -157,6 +169,8 @@ void QUmlTestIdentityAction::setFirst(QUmlInputPin *first) /*! Tells whether the two input objects are identical. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlTestIdentityAction::result() const { @@ -165,6 +179,9 @@ QUmlOutputPin *QUmlTestIdentityAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlTestIdentityAction::setResult(QUmlOutputPin *result) { // This is a read-write association end @@ -187,6 +204,8 @@ void QUmlTestIdentityAction::setResult(QUmlOutputPin *result) /*! Gives the pin on which an object is placed. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlTestIdentityAction::second() const { @@ -195,6 +214,9 @@ QUmlInputPin *QUmlTestIdentityAction::second() const return _second; } +/*! + Adjusts second to \a second. + */ void QUmlTestIdentityAction::setSecond(QUmlInputPin *second) { // This is a read-write association end diff --git a/src/uml/qumltestidentityaction.h b/src/uml/qumltestidentityaction.h index 45316052..f638bbd4 100644 --- a/src/uml/qumltestidentityaction.h +++ b/src/uml/qumltestidentityaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -79,7 +77,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTestIdentityAction) *) -QT_END_HEADER - #endif // QUMLTESTIDENTITYACTION_H diff --git a/src/uml/qumltimeconstraint.cpp b/src/uml/qumltimeconstraint.cpp index 158fe104..b4217046 100644 --- a/src/uml/qumltimeconstraint.cpp +++ b/src/uml/qumltimeconstraint.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief A time constraint is a constraint that refers to a time interval. */ + +/*! + Creates a new QUmlTimeConstraint. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTimeConstraint::QUmlTimeConstraint(bool createQModelingObject) : QUmlIntervalConstraint(false), _firstEvent(true), @@ -73,6 +77,9 @@ QUmlTimeConstraint::QUmlTimeConstraint(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTimeConstraintObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTimeConstraint. +*/ QModelingElement *QUmlTimeConstraint::clone() const { QUmlTimeConstraint *c = new QUmlTimeConstraint; @@ -110,6 +117,9 @@ bool QUmlTimeConstraint::firstEvent() const return _firstEvent; } +/*! + Adjusts firstEvent to \a firstEvent. + */ void QUmlTimeConstraint::setFirstEvent(bool firstEvent) { // This is a read-write property @@ -122,6 +132,8 @@ void QUmlTimeConstraint::setFirstEvent(bool firstEvent) /*! A condition that must be true when evaluated in order for the constraint to be satisfied. + + \b {Redefined property(ies):} QUmlIntervalConstraint::specification(). */ QUmlTimeInterval *QUmlTimeConstraint::specification() const { @@ -130,6 +142,9 @@ QUmlTimeInterval *QUmlTimeConstraint::specification() const return _specification; } +/*! + Adjusts specification to \a specification. + */ void QUmlTimeConstraint::setSpecification(QUmlTimeInterval *specification) { // This is a read-write association end diff --git a/src/uml/qumltimeconstraint.h b/src/uml/qumltimeconstraint.h index a4c39237..3a5e22d6 100644 --- a/src/uml/qumltimeconstraint.h +++ b/src/uml/qumltimeconstraint.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlIntervalConstraint> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTimeConstraint) *) -QT_END_HEADER - #endif // QUMLTIMECONSTRAINT_H diff --git a/src/uml/qumltimeevent.cpp b/src/uml/qumltimeevent.cpp index bb45e6ac..43e1f96a 100644 --- a/src/uml/qumltimeevent.cpp +++ b/src/uml/qumltimeevent.cpp @@ -62,6 +62,10 @@ QT_BEGIN_NAMESPACE \brief A time event can be defined relative to entering the current state of the executing state machine.A time event specifies a point in time. At the specified time, the event occurs. */ + +/*! + Creates a new QUmlTimeEvent. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTimeEvent::QUmlTimeEvent(bool createQModelingObject) : _isRelative(false), _when(0) @@ -70,6 +74,9 @@ QUmlTimeEvent::QUmlTimeEvent(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTimeEventObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTimeEvent. +*/ QModelingElement *QUmlTimeEvent::clone() const { QUmlTimeEvent *c = new QUmlTimeEvent; @@ -103,6 +110,9 @@ bool QUmlTimeEvent::isRelative() const return _isRelative; } +/*! + Adjusts isRelative to \a isRelative. + */ void QUmlTimeEvent::setRelative(bool isRelative) { // This is a read-write property @@ -115,6 +125,8 @@ void QUmlTimeEvent::setRelative(bool isRelative) /*! Specifies the corresponding time deadline. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlTimeExpression *QUmlTimeEvent::when() const { @@ -123,6 +135,9 @@ QUmlTimeExpression *QUmlTimeEvent::when() const return _when; } +/*! + Adjusts when to \a when. + */ void QUmlTimeEvent::setWhen(QUmlTimeExpression *when) { // This is a read-write association end diff --git a/src/uml/qumltimeevent.h b/src/uml/qumltimeevent.h index 2ecf7fbf..2443d73a 100644 --- a/src/uml/qumltimeevent.h +++ b/src/uml/qumltimeevent.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlEvent> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTimeEvent) *) -QT_END_HEADER - #endif // QUMLTIMEEVENT_H diff --git a/src/uml/qumltimeexpression.cpp b/src/uml/qumltimeexpression.cpp index ccba0738..cc5f890e 100644 --- a/src/uml/qumltimeexpression.cpp +++ b/src/uml/qumltimeexpression.cpp @@ -63,6 +63,10 @@ QT_BEGIN_NAMESPACE \brief A time expression defines a value specification that represents a time value. */ + +/*! + Creates a new QUmlTimeExpression. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTimeExpression::QUmlTimeExpression(bool createQModelingObject) : _expr(0) { @@ -70,6 +74,9 @@ QUmlTimeExpression::QUmlTimeExpression(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTimeExpressionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTimeExpression. +*/ QModelingElement *QUmlTimeExpression::clone() const { QUmlTimeExpression *c = new QUmlTimeExpression; @@ -98,6 +105,8 @@ QModelingElement *QUmlTimeExpression::clone() const /*! The value of the time expression. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlTimeExpression::expr() const { @@ -106,6 +115,9 @@ QUmlValueSpecification *QUmlTimeExpression::expr() const return _expr; } +/*! + Adjusts expr to \a expr. + */ void QUmlTimeExpression::setExpr(QUmlValueSpecification *expr) { // This is a read-write association end @@ -128,6 +140,8 @@ void QUmlTimeExpression::setExpr(QUmlValueSpecification *expr) /*! Refers to the time and duration observations that are involved in expr. + + \sa addObservation(), removeObservation() */ const QSet<QUmlObservation *> QUmlTimeExpression::observations() const { @@ -136,6 +150,11 @@ const QSet<QUmlObservation *> QUmlTimeExpression::observations() const return _observations; } +/*! + Adds \a observation to observations. + + \sa observations(), removeObservation() + */ void QUmlTimeExpression::addObservation(QUmlObservation *observation) { // This is a read-write association end @@ -147,6 +166,11 @@ void QUmlTimeExpression::addObservation(QUmlObservation *observation) } } +/*! + Removes \a observation from observations. + + \sa observations(), addObservation() + */ void QUmlTimeExpression::removeObservation(QUmlObservation *observation) { // This is a read-write association end diff --git a/src/uml/qumltimeexpression.h b/src/uml/qumltimeexpression.h index 18d77a4b..0aff4814 100644 --- a/src/uml/qumltimeexpression.h +++ b/src/uml/qumltimeexpression.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlValueSpecification> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTimeExpression) *) -QT_END_HEADER - #endif // QUMLTIMEEXPRESSION_H diff --git a/src/uml/qumltimeinterval.cpp b/src/uml/qumltimeinterval.cpp index d7932a13..d4705668 100644 --- a/src/uml/qumltimeinterval.cpp +++ b/src/uml/qumltimeinterval.cpp @@ -64,6 +64,10 @@ QT_BEGIN_NAMESPACE \brief A time interval defines the range between two time expressions. */ + +/*! + Creates a new QUmlTimeInterval. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTimeInterval::QUmlTimeInterval(bool createQModelingObject) : QUmlInterval(false), _max(0), @@ -73,6 +77,9 @@ QUmlTimeInterval::QUmlTimeInterval(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTimeIntervalObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTimeInterval. +*/ QModelingElement *QUmlTimeInterval::clone() const { QUmlTimeInterval *c = new QUmlTimeInterval; @@ -101,6 +108,8 @@ QModelingElement *QUmlTimeInterval::clone() const /*! Refers to the TimeExpression denoting the maximum value of the range. + + \b {Redefined property(ies):} QUmlInterval::max(). */ QUmlTimeExpression *QUmlTimeInterval::max() const { @@ -109,6 +118,9 @@ QUmlTimeExpression *QUmlTimeInterval::max() const return _max; } +/*! + Adjusts max to \a max. + */ void QUmlTimeInterval::setMax(QUmlTimeExpression *max) { // This is a read-write association end @@ -125,6 +137,8 @@ void QUmlTimeInterval::setMax(QUmlTimeExpression *max) /*! Refers to the TimeExpression denoting the minimum value of the range. + + \b {Redefined property(ies):} QUmlInterval::min(). */ QUmlTimeExpression *QUmlTimeInterval::min() const { @@ -133,6 +147,9 @@ QUmlTimeExpression *QUmlTimeInterval::min() const return _min; } +/*! + Adjusts min to \a min. + */ void QUmlTimeInterval::setMin(QUmlTimeExpression *min) { // This is a read-write association end diff --git a/src/uml/qumltimeinterval.h b/src/uml/qumltimeinterval.h index 71593791..5034078b 100644 --- a/src/uml/qumltimeinterval.h +++ b/src/uml/qumltimeinterval.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInterval> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTimeInterval) *) -QT_END_HEADER - #endif // QUMLTIMEINTERVAL_H diff --git a/src/uml/qumltimeobservation.cpp b/src/uml/qumltimeobservation.cpp index abcff4a9..72657c31 100644 --- a/src/uml/qumltimeobservation.cpp +++ b/src/uml/qumltimeobservation.cpp @@ -61,6 +61,10 @@ QT_BEGIN_NAMESPACE \brief A time observation is a reference to a time instant during an execution. It points out the element in the model to observe and whether the observation is when this model element is entered or when it is exited. */ + +/*! + Creates a new QUmlTimeObservation. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTimeObservation::QUmlTimeObservation(bool createQModelingObject) : _event_(0), _firstEvent(true) @@ -69,6 +73,9 @@ QUmlTimeObservation::QUmlTimeObservation(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTimeObservationObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTimeObservation. +*/ QModelingElement *QUmlTimeObservation::clone() const { QUmlTimeObservation *c = new QUmlTimeObservation; @@ -102,6 +109,9 @@ QUmlNamedElement *QUmlTimeObservation::event_() const return _event_; } +/*! + Adjusts event_ to \a event_. + */ void QUmlTimeObservation::setEvent(QUmlNamedElement *event_) { // This is a read-write association end @@ -123,6 +133,9 @@ bool QUmlTimeObservation::firstEvent() const return _firstEvent; } +/*! + Adjusts firstEvent to \a firstEvent. + */ void QUmlTimeObservation::setFirstEvent(bool firstEvent) { // This is a read-write property diff --git a/src/uml/qumltimeobservation.h b/src/uml/qumltimeobservation.h index 8d2435a4..efb99d55 100644 --- a/src/uml/qumltimeobservation.h +++ b/src/uml/qumltimeobservation.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlObservation> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTimeObservation) *) -QT_END_HEADER - #endif // QUMLTIMEOBSERVATION_H diff --git a/src/uml/qumltransition.cpp b/src/uml/qumltransition.cpp index 6bf528ee..63e1aabd 100644 --- a/src/uml/qumltransition.cpp +++ b/src/uml/qumltransition.cpp @@ -68,6 +68,10 @@ QT_BEGIN_NAMESPACE \brief A transition is a directed relationship between a source vertex and a target vertex. It may be part of a compound transition, which takes the state machine from one state configuration to another, representing the complete response of the state machine to an occurrence of an event of a particular type. */ + +/*! + Creates a new QUmlTransition. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTransition::QUmlTransition(bool createQModelingObject) : _container(0), _effect(0), @@ -81,6 +85,9 @@ QUmlTransition::QUmlTransition(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTransitionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTransition. +*/ QModelingElement *QUmlTransition::clone() const { QUmlTransition *c = new QUmlTransition; @@ -121,6 +128,10 @@ QModelingElement *QUmlTransition::clone() const /*! Designates the region that owns this transition. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlRegion::transitions(). */ QUmlRegion *QUmlTransition::container() const { @@ -129,6 +140,9 @@ QUmlRegion *QUmlTransition::container() const return _container; } +/*! + Adjusts container to \a container. + */ void QUmlTransition::setContainer(QUmlRegion *container) { // This is a read-write association end @@ -147,6 +161,8 @@ void QUmlTransition::setContainer(QUmlRegion *container) /*! Specifies an optional behavior to be performed when the transition fires. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlBehavior *QUmlTransition::effect() const { @@ -155,6 +171,9 @@ QUmlBehavior *QUmlTransition::effect() const return _effect; } +/*! + Adjusts effect to \a effect. + */ void QUmlTransition::setEffect(QUmlBehavior *effect) { // This is a read-write association end @@ -177,6 +196,8 @@ void QUmlTransition::setEffect(QUmlBehavior *effect) /*! A guard is a constraint that provides a fine-grained control over the firing of the transition. The guard is evaluated when an event occurrence is dispatched by the state machine. If the guard is true at that time, the transition may be enabled, otherwise, it is disabled. Guards should be pure expressions without side effects. Guard expressions with side effects are ill formed. + + \b {Subsetted property(ies):} QUmlNamespace::ownedRules(). */ QUmlConstraint *QUmlTransition::guard() const { @@ -185,6 +206,9 @@ QUmlConstraint *QUmlTransition::guard() const return _guard; } +/*! + Adjusts guard to \a guard. + */ void QUmlTransition::setGuard(QUmlConstraint *guard) { // This is a read-write association end @@ -215,6 +239,9 @@ QtUml::TransitionKind QUmlTransition::kind() const return _kind; } +/*! + Adjusts kind to \a kind. + */ void QUmlTransition::setKind(QtUml::TransitionKind kind) { // This is a read-write property @@ -227,6 +254,8 @@ void QUmlTransition::setKind(QtUml::TransitionKind kind) /*! The transition that is redefined by this transition. + + \b {Subsetted property(ies):} QUmlRedefinableElement::redefinedElements(). */ QUmlTransition *QUmlTransition::redefinedTransition() const { @@ -235,6 +264,9 @@ QUmlTransition *QUmlTransition::redefinedTransition() const return _redefinedTransition; } +/*! + Adjusts redefinedTransition to \a redefinedTransition. + */ void QUmlTransition::setRedefinedTransition(QUmlTransition *redefinedTransition) { // This is a read-write association end @@ -256,6 +288,10 @@ void QUmlTransition::setRedefinedTransition(QUmlTransition *redefinedTransition) /*! References the classifier in which context this element may be redefined. + + \b {This is a read-only derived property.} + + \b {Redefined property(ies):} QUmlRedefinableElement::redefinitionContexts(). */ QUmlClassifier *QUmlTransition::redefinitionContext() const { @@ -266,6 +302,9 @@ QUmlClassifier *QUmlTransition::redefinitionContext() const return 0; } +/*! + Adjusts redefinitionContext to \a redefinitionContext. + */ void QUmlTransition::setRedefinitionContext(QUmlClassifier *redefinitionContext) { // This is a read-only derived association end @@ -287,6 +326,8 @@ void QUmlTransition::setRedefinitionContext(QUmlClassifier *redefinitionContext) /*! Designates the originating vertex (state or pseudostate) of the transition. + + \b {Opposite property(ies):} QUmlVertex::outgoings(). */ QUmlVertex *QUmlTransition::source() const { @@ -295,6 +336,9 @@ QUmlVertex *QUmlTransition::source() const return _source; } +/*! + Adjusts source to \a source. + */ void QUmlTransition::setSource(QUmlVertex *source) { // This is a read-write association end @@ -308,6 +352,8 @@ void QUmlTransition::setSource(QUmlVertex *source) /*! Designates the target vertex that is reached when the transition is taken. + + \b {Opposite property(ies):} QUmlVertex::incomings(). */ QUmlVertex *QUmlTransition::target() const { @@ -316,6 +362,9 @@ QUmlVertex *QUmlTransition::target() const return _target; } +/*! + Adjusts target to \a target. + */ void QUmlTransition::setTarget(QUmlVertex *target) { // This is a read-write association end @@ -329,6 +378,10 @@ void QUmlTransition::setTarget(QUmlVertex *target) /*! Specifies the triggers that may fire the transition. + + \sa addTrigger(), removeTrigger() + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ const QSet<QUmlTrigger *> QUmlTransition::triggers() const { @@ -337,6 +390,11 @@ const QSet<QUmlTrigger *> QUmlTransition::triggers() const return _triggers; } +/*! + Adds \a trigger to triggers. + + \sa triggers(), removeTrigger() + */ void QUmlTransition::addTrigger(QUmlTrigger *trigger) { // This is a read-write association end @@ -352,6 +410,11 @@ void QUmlTransition::addTrigger(QUmlTrigger *trigger) } } +/*! + Removes \a trigger from triggers. + + \sa triggers(), addTrigger() + */ void QUmlTransition::removeTrigger(QUmlTrigger *trigger) { // This is a read-write association end diff --git a/src/uml/qumltransition.h b/src/uml/qumltransition.h index fda2b4da..1944b84e 100644 --- a/src/uml/qumltransition.h +++ b/src/uml/qumltransition.h @@ -48,8 +48,6 @@ #include <QtUml/QtUmlNamespace> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -109,7 +107,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTransition) *) -QT_END_HEADER - #endif // QUMLTRANSITION_H diff --git a/src/uml/qumltrigger.cpp b/src/uml/qumltrigger.cpp index b661f502..df0584e1 100644 --- a/src/uml/qumltrigger.cpp +++ b/src/uml/qumltrigger.cpp @@ -60,6 +60,10 @@ QT_BEGIN_NAMESPACE \brief A trigger specification may be qualified by the port on which the event occurred.A trigger relates an event to a behavior that may affect an instance of the classifier. */ + +/*! + Creates a new QUmlTrigger. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlTrigger::QUmlTrigger(bool createQModelingObject) : _event_(0) { @@ -67,6 +71,9 @@ QUmlTrigger::QUmlTrigger(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlTriggerObject(this)); } +/*! + Returns a deep-copied clone of the QUmlTrigger. +*/ QModelingElement *QUmlTrigger::clone() const { QUmlTrigger *c = new QUmlTrigger; @@ -97,6 +104,9 @@ QUmlEvent *QUmlTrigger::event_() const return _event_; } +/*! + Adjusts event_ to \a event_. + */ void QUmlTrigger::setEvent(QUmlEvent *event_) { // This is a read-write association end @@ -110,6 +120,8 @@ void QUmlTrigger::setEvent(QUmlEvent *event_) /*! A optional port of the receiver object on which the behavioral feature is invoked. + + \sa addPort(), removePort() */ const QSet<QUmlPort *> QUmlTrigger::ports() const { @@ -118,6 +130,11 @@ const QSet<QUmlPort *> QUmlTrigger::ports() const return _ports; } +/*! + Adds \a port to ports. + + \sa ports(), removePort() + */ void QUmlTrigger::addPort(QUmlPort *port) { // This is a read-write association end @@ -129,6 +146,11 @@ void QUmlTrigger::addPort(QUmlPort *port) } } +/*! + Removes \a port from ports. + + \sa ports(), addPort() + */ void QUmlTrigger::removePort(QUmlPort *port) { // This is a read-write association end diff --git a/src/uml/qumltrigger.h b/src/uml/qumltrigger.h index f11cfa36..8b6be34e 100644 --- a/src/uml/qumltrigger.h +++ b/src/uml/qumltrigger.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -77,7 +75,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTrigger) *) -QT_END_HEADER - #endif // QUMLTRIGGER_H diff --git a/src/uml/qumltype.cpp b/src/uml/qumltype.cpp index 6d829be1..fa943979 100644 --- a/src/uml/qumltype.cpp +++ b/src/uml/qumltype.cpp @@ -58,12 +58,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A type is a named element that is used as the type for a typed element. A type can be contained in a package.A type constrains the values represented by a typed element. + + \b {QUmlType is an abstract class.} */ + +/*! + Creates a new QUmlType. +*/ QUmlType::QUmlType() : _package(0) { } +/*! + Returns a deep-copied clone of the QUmlType. +*/ QModelingElement *QUmlType::clone() const { QUmlType *c = new QUmlType; @@ -88,6 +97,10 @@ QModelingElement *QUmlType::clone() const /*! Specifies the owning package of this classifier, if any. + + \b {Subsetted property(ies):} . + + \b {Opposite property(ies):} QUmlPackage::ownedTypes(). */ QUmlPackage *QUmlType::package() const { @@ -96,6 +109,9 @@ QUmlPackage *QUmlType::package() const return _package; } +/*! + Adjusts package to \a package. + */ void QUmlType::setPackage(QUmlPackage *package) { // This is a read-write association end diff --git a/src/uml/qumltype.h b/src/uml/qumltype.h index e9b2508e..8fa9eba0 100644 --- a/src/uml/qumltype.h +++ b/src/uml/qumltype.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlPackageableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -75,7 +73,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlType) *) -QT_END_HEADER - #endif // QUMLTYPE_H diff --git a/src/uml/qumltypedelement.cpp b/src/uml/qumltypedelement.cpp index 5c011619..9e950d94 100644 --- a/src/uml/qumltypedelement.cpp +++ b/src/uml/qumltypedelement.cpp @@ -56,12 +56,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A typed element is a kind of named element that represents an element with a type.A typed element has a type. + + \b {QUmlTypedElement is an abstract class.} */ + +/*! + Creates a new QUmlTypedElement. +*/ QUmlTypedElement::QUmlTypedElement() : _type(0) { } +/*! + Returns a deep-copied clone of the QUmlTypedElement. +*/ QModelingElement *QUmlTypedElement::clone() const { QUmlTypedElement *c = new QUmlTypedElement; @@ -90,6 +99,9 @@ QUmlType *QUmlTypedElement::type() const return _type; } +/*! + Adjusts type to \a type. + */ void QUmlTypedElement::setType(QUmlType *type) { // This is a read-write association end diff --git a/src/uml/qumltypedelement.h b/src/uml/qumltypedelement.h index 34b055b4..8e74c776 100644 --- a/src/uml/qumltypedelement.h +++ b/src/uml/qumltypedelement.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlTypedElement) *) -QT_END_HEADER - #endif // QUMLTYPEDELEMENT_H diff --git a/src/uml/qumlunmarshallaction.cpp b/src/uml/qumlunmarshallaction.cpp index 1eaadf2f..3ad2bf05 100644 --- a/src/uml/qumlunmarshallaction.cpp +++ b/src/uml/qumlunmarshallaction.cpp @@ -72,6 +72,10 @@ QT_BEGIN_NAMESPACE \brief An unmarshall action is an action that breaks an object of a known type into outputs each of which is equal to a value from a structural feature of the object. */ + +/*! + Creates a new QUmlUnmarshallAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlUnmarshallAction::QUmlUnmarshallAction(bool createQModelingObject) : _object(0), _unmarshallType(0) @@ -80,6 +84,9 @@ QUmlUnmarshallAction::QUmlUnmarshallAction(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlUnmarshallActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlUnmarshallAction. +*/ QModelingElement *QUmlUnmarshallAction::clone() const { QUmlUnmarshallAction *c = new QUmlUnmarshallAction; @@ -126,6 +133,8 @@ QModelingElement *QUmlUnmarshallAction::clone() const /*! The object to be unmarshalled. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlUnmarshallAction::object() const { @@ -134,6 +143,9 @@ QUmlInputPin *QUmlUnmarshallAction::object() const return _object; } +/*! + Adjusts object to \a object. + */ void QUmlUnmarshallAction::setObject(QUmlInputPin *object) { // This is a read-write association end @@ -156,6 +168,10 @@ void QUmlUnmarshallAction::setObject(QUmlInputPin *object) /*! The values of the structural features of the input object. + + \sa addResult(), removeResult() + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ const QSet<QUmlOutputPin *> QUmlUnmarshallAction::results() const { @@ -164,6 +180,11 @@ const QSet<QUmlOutputPin *> QUmlUnmarshallAction::results() const return _results; } +/*! + Adds \a result to results. + + \sa results(), removeResult() + */ void QUmlUnmarshallAction::addResult(QUmlOutputPin *result) { // This is a read-write association end @@ -179,6 +200,11 @@ void QUmlUnmarshallAction::addResult(QUmlOutputPin *result) } } +/*! + Removes \a result from results. + + \sa results(), addResult() + */ void QUmlUnmarshallAction::removeResult(QUmlOutputPin *result) { // This is a read-write association end @@ -203,6 +229,9 @@ QUmlClassifier *QUmlUnmarshallAction::unmarshallType() const return _unmarshallType; } +/*! + Adjusts unmarshallType to \a unmarshallType. + */ void QUmlUnmarshallAction::setUnmarshallType(QUmlClassifier *unmarshallType) { // This is a read-write association end diff --git a/src/uml/qumlunmarshallaction.h b/src/uml/qumlunmarshallaction.h index feae05fa..ff0f4bd7 100644 --- a/src/uml/qumlunmarshallaction.h +++ b/src/uml/qumlunmarshallaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlUnmarshallAction) *) -QT_END_HEADER - #endif // QUMLUNMARSHALLACTION_H diff --git a/src/uml/qumlusage.cpp b/src/uml/qumlusage.cpp index 18231bbf..d29488c6 100644 --- a/src/uml/qumlusage.cpp +++ b/src/uml/qumlusage.cpp @@ -60,6 +60,10 @@ QT_BEGIN_NAMESPACE \brief A usage is a relationship in which one element requires another element (or set of elements) for its full implementation or operation. A usage is a dependency in which the client requires the presence of the supplier. */ + +/*! + Creates a new QUmlUsage. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlUsage::QUmlUsage(bool createQModelingObject) : QUmlDependency(false) { @@ -67,6 +71,9 @@ QUmlUsage::QUmlUsage(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlUsageObject(this)); } +/*! + Returns a deep-copied clone of the QUmlUsage. +*/ QModelingElement *QUmlUsage::clone() const { QUmlUsage *c = new QUmlUsage; diff --git a/src/uml/qumlusage.h b/src/uml/qumlusage.h index db3329e7..463614f9 100644 --- a/src/uml/qumlusage.h +++ b/src/uml/qumlusage.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlDependency> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlUsage) *) -QT_END_HEADER - #endif // QUMLUSAGE_H diff --git a/src/uml/qumlusecase.cpp b/src/uml/qumlusecase.cpp index 95fb67f0..9d87aae5 100644 --- a/src/uml/qumlusecase.cpp +++ b/src/uml/qumlusecase.cpp @@ -83,12 +83,19 @@ QT_BEGIN_NAMESPACE \brief A use case is the specification of a set of actions performed by a system, which yields an observable result that is, typically, of value for one or more actors or other stakeholders of the system. */ + +/*! + Creates a new QUmlUseCase. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlUseCase::QUmlUseCase(bool createQModelingObject) { if (createQModelingObject) _qModelingObject = qobject_cast<QModelingObject *>(new QUmlUseCaseObject(this)); } +/*! + Returns a deep-copied clone of the QUmlUseCase. +*/ QModelingElement *QUmlUseCase::clone() const { QUmlUseCase *c = new QUmlUseCase; @@ -156,6 +163,12 @@ QModelingElement *QUmlUseCase::clone() const /*! References the Extend relationships owned by this use case. + + \sa addExtend(), removeExtend() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlExtend::extension(). */ const QSet<QUmlExtend *> QUmlUseCase::extends() const { @@ -164,6 +177,11 @@ const QSet<QUmlExtend *> QUmlUseCase::extends() const return _extends; } +/*! + Adds \a extend to extends. + + \sa extends(), removeExtend() + */ void QUmlUseCase::addExtend(QUmlExtend *extend) { // This is a read-write association end @@ -184,6 +202,11 @@ void QUmlUseCase::addExtend(QUmlExtend *extend) } } +/*! + Removes \a extend from extends. + + \sa extends(), addExtend() + */ void QUmlUseCase::removeExtend(QUmlExtend *extend) { // This is a read-write association end @@ -205,6 +228,12 @@ void QUmlUseCase::removeExtend(QUmlExtend *extend) /*! References the ExtensionPoints owned by the use case. + + \sa addExtensionPoint(), removeExtensionPoint() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlExtensionPoint::useCase(). */ const QSet<QUmlExtensionPoint *> QUmlUseCase::extensionPoints() const { @@ -213,6 +242,11 @@ const QSet<QUmlExtensionPoint *> QUmlUseCase::extensionPoints() const return _extensionPoints; } +/*! + Adds \a extensionPoint to extensionPoints. + + \sa extensionPoints(), removeExtensionPoint() + */ void QUmlUseCase::addExtensionPoint(QUmlExtensionPoint *extensionPoint) { // This is a read-write association end @@ -233,6 +267,11 @@ void QUmlUseCase::addExtensionPoint(QUmlExtensionPoint *extensionPoint) } } +/*! + Removes \a extensionPoint from extensionPoints. + + \sa extensionPoints(), addExtensionPoint() + */ void QUmlUseCase::removeExtensionPoint(QUmlExtensionPoint *extensionPoint) { // This is a read-write association end @@ -254,6 +293,12 @@ void QUmlUseCase::removeExtensionPoint(QUmlExtensionPoint *extensionPoint) /*! References the Include relationships owned by this use case. + + \sa addInclude(), removeInclude() + + \b {Subsetted property(ies):} QUmlNamespace::ownedMembers(). + + \b {Opposite property(ies):} QUmlInclude::includingCase(). */ const QSet<QUmlInclude *> QUmlUseCase::includes() const { @@ -262,6 +307,11 @@ const QSet<QUmlInclude *> QUmlUseCase::includes() const return _includes; } +/*! + Adds \a include to includes. + + \sa includes(), removeInclude() + */ void QUmlUseCase::addInclude(QUmlInclude *include) { // This is a read-write association end @@ -282,6 +332,11 @@ void QUmlUseCase::addInclude(QUmlInclude *include) } } +/*! + Removes \a include from includes. + + \sa includes(), addInclude() + */ void QUmlUseCase::removeInclude(QUmlInclude *include) { // This is a read-write association end @@ -303,6 +358,10 @@ void QUmlUseCase::removeInclude(QUmlInclude *include) /*! References the subjects to which this use case applies. The subject or its parts realize all the use cases that apply to this subject. Use cases need not be attached to any specific subject, however. The subject may, but need not, own the use cases that apply to it. + + \sa addSubject(), removeSubject() + + \b {Opposite property(ies):} QUmlClassifier::useCases(). */ const QSet<QUmlClassifier *> QUmlUseCase::subjects() const { @@ -311,6 +370,11 @@ const QSet<QUmlClassifier *> QUmlUseCase::subjects() const return _subjects; } +/*! + Adds \a subject to subjects. + + \sa subjects(), removeSubject() + */ void QUmlUseCase::addSubject(QUmlClassifier *subject) { // This is a read-write association end @@ -327,6 +391,11 @@ void QUmlUseCase::addSubject(QUmlClassifier *subject) } } +/*! + Removes \a subject from subjects. + + \sa subjects(), addSubject() + */ void QUmlUseCase::removeSubject(QUmlClassifier *subject) { // This is a read-write association end diff --git a/src/uml/qumlusecase.h b/src/uml/qumlusecase.h index 1d241b6a..9b81d326 100644 --- a/src/uml/qumlusecase.h +++ b/src/uml/qumlusecase.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlBehavioredClassifier> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -91,7 +89,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlUseCase) *) -QT_END_HEADER - #endif // QUMLUSECASE_H diff --git a/src/uml/qumlvaluepin.cpp b/src/uml/qumlvaluepin.cpp index 0ff5c840..6b822f31 100644 --- a/src/uml/qumlvaluepin.cpp +++ b/src/uml/qumlvaluepin.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A value pin is an input pin that provides a value by evaluating a value specification. */ + +/*! + Creates a new QUmlValuePin. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlValuePin::QUmlValuePin(bool createQModelingObject) : QUmlInputPin(false), _value(0) @@ -81,6 +85,9 @@ QUmlValuePin::QUmlValuePin(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlValuePinObject(this)); } +/*! + Returns a deep-copied clone of the QUmlValuePin. +*/ QModelingElement *QUmlValuePin::clone() const { QUmlValuePin *c = new QUmlValuePin; @@ -133,6 +140,8 @@ QModelingElement *QUmlValuePin::clone() const /*! Value that the pin will provide. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlValuePin::value() const { @@ -141,6 +150,9 @@ QUmlValueSpecification *QUmlValuePin::value() const return _value; } +/*! + Adjusts value to \a value. + */ void QUmlValuePin::setValue(QUmlValueSpecification *value) { // This is a read-write association end diff --git a/src/uml/qumlvaluepin.h b/src/uml/qumlvaluepin.h index 7e95b991..7ae83eef 100644 --- a/src/uml/qumlvaluepin.h +++ b/src/uml/qumlvaluepin.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlInputPin> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlValuePin) *) -QT_END_HEADER - #endif // QUMLVALUEPIN_H diff --git a/src/uml/qumlvaluespecification.cpp b/src/uml/qumlvaluespecification.cpp index 4163088c..18bdd1a1 100644 --- a/src/uml/qumlvaluespecification.cpp +++ b/src/uml/qumlvaluespecification.cpp @@ -59,11 +59,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief ValueSpecification specializes ParameterableElement to specify that a value specification can be exposed as a formal template parameter, and provided as an actual parameter in a binding of a template.A value specification is the specification of a (possibly empty) set of instances, including both objects and data values. + + \b {QUmlValueSpecification is an abstract class.} */ + +/*! + Creates a new QUmlValueSpecification. +*/ QUmlValueSpecification::QUmlValueSpecification() { } +/*! + Returns a deep-copied clone of the QUmlValueSpecification. +*/ QModelingElement *QUmlValueSpecification::clone() const { QUmlValueSpecification *c = new QUmlValueSpecification; diff --git a/src/uml/qumlvaluespecification.h b/src/uml/qumlvaluespecification.h index 2854b7b8..be13c5a1 100644 --- a/src/uml/qumlvaluespecification.h +++ b/src/uml/qumlvaluespecification.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlTypedElement> #include <QtUml/QUmlPackageableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -79,7 +77,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlValueSpecification) *) -QT_END_HEADER - #endif // QUMLVALUESPECIFICATION_H diff --git a/src/uml/qumlvaluespecificationaction.cpp b/src/uml/qumlvaluespecificationaction.cpp index 0194a499..e07ae176 100644 --- a/src/uml/qumlvaluespecificationaction.cpp +++ b/src/uml/qumlvaluespecificationaction.cpp @@ -73,6 +73,10 @@ QT_BEGIN_NAMESPACE \brief A value specification action is an action that evaluates a value specification. */ + +/*! + Creates a new QUmlValueSpecificationAction. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlValueSpecificationAction::QUmlValueSpecificationAction(bool createQModelingObject) : _result(0), _value(0) @@ -81,6 +85,9 @@ QUmlValueSpecificationAction::QUmlValueSpecificationAction(bool createQModelingO _qModelingObject = qobject_cast<QModelingObject *>(new QUmlValueSpecificationActionObject(this)); } +/*! + Returns a deep-copied clone of the QUmlValueSpecificationAction. +*/ QModelingElement *QUmlValueSpecificationAction::clone() const { QUmlValueSpecificationAction *c = new QUmlValueSpecificationAction; @@ -125,6 +132,8 @@ QModelingElement *QUmlValueSpecificationAction::clone() const /*! Gives the output pin on which the result is put. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlValueSpecificationAction::result() const { @@ -133,6 +142,9 @@ QUmlOutputPin *QUmlValueSpecificationAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlValueSpecificationAction::setResult(QUmlOutputPin *result) { // This is a read-write association end @@ -155,6 +167,8 @@ void QUmlValueSpecificationAction::setResult(QUmlOutputPin *result) /*! Value specification to be evaluated. + + \b {Subsetted property(ies):} QUmlElement::ownedElements(). */ QUmlValueSpecification *QUmlValueSpecificationAction::value() const { @@ -163,6 +177,9 @@ QUmlValueSpecification *QUmlValueSpecificationAction::value() const return _value; } +/*! + Adjusts value to \a value. + */ void QUmlValueSpecificationAction::setValue(QUmlValueSpecification *value) { // This is a read-write association end diff --git a/src/uml/qumlvaluespecificationaction.h b/src/uml/qumlvaluespecificationaction.h index 59bb459b..113bd14f 100644 --- a/src/uml/qumlvaluespecificationaction.h +++ b/src/uml/qumlvaluespecificationaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlValueSpecificationAction) *) -QT_END_HEADER - #endif // QUMLVALUESPECIFICATIONACTION_H diff --git a/src/uml/qumlvariable.cpp b/src/uml/qumlvariable.cpp index 08042e06..55fb660f 100644 --- a/src/uml/qumlvariable.cpp +++ b/src/uml/qumlvariable.cpp @@ -68,6 +68,10 @@ QT_BEGIN_NAMESPACE \brief A variable is considered a connectable element.Variables are elements for passing data between actions indirectly. A local variable stores values shared by the actions within a structured activity group but not accessible outside it. The output of an action may be written to a variable and read for the input to a subsequent action, which is effectively an indirect data flow path. Because there is no predefined relationship between actions that read and write variables, these actions must be sequenced by control flows to prevent race conditions that may occur between actions that read or write the same variable. */ + +/*! + Creates a new QUmlVariable. Also creates the corresponding QObject-based representation returned by asQModelingObject() if \a createQModelingObject is true. +*/ QUmlVariable::QUmlVariable(bool createQModelingObject) : _activityScope(0), _scope(0) @@ -76,6 +80,9 @@ QUmlVariable::QUmlVariable(bool createQModelingObject) : _qModelingObject = qobject_cast<QModelingObject *>(new QUmlVariableObject(this)); } +/*! + Returns a deep-copied clone of the QUmlVariable. +*/ QModelingElement *QUmlVariable::clone() const { QUmlVariable *c = new QUmlVariable; @@ -110,6 +117,10 @@ QModelingElement *QUmlVariable::clone() const /*! An activity that owns the variable. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlActivity::variables(). */ QUmlActivity *QUmlVariable::activityScope() const { @@ -118,6 +129,9 @@ QUmlActivity *QUmlVariable::activityScope() const return _activityScope; } +/*! + Adjusts activityScope to \a activityScope. + */ void QUmlVariable::setActivityScope(QUmlActivity *activityScope) { // This is a read-write association end @@ -136,6 +150,10 @@ void QUmlVariable::setActivityScope(QUmlActivity *activityScope) /*! A structured activity node that owns the variable. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlStructuredActivityNode::variables(). */ QUmlStructuredActivityNode *QUmlVariable::scope() const { @@ -144,6 +162,9 @@ QUmlStructuredActivityNode *QUmlVariable::scope() const return _scope; } +/*! + Adjusts scope to \a scope. + */ void QUmlVariable::setScope(QUmlStructuredActivityNode *scope) { // This is a read-write association end diff --git a/src/uml/qumlvariable.h b/src/uml/qumlvariable.h index 2dd6c168..0813bd14 100644 --- a/src/uml/qumlvariable.h +++ b/src/uml/qumlvariable.h @@ -46,8 +46,6 @@ #include <QtUml/QUmlMultiplicityElement> #include <QtUml/QUmlConnectableElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -81,7 +79,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlVariable) *) -QT_END_HEADER - #endif // QUMLVARIABLE_H diff --git a/src/uml/qumlvariableaction.cpp b/src/uml/qumlvariableaction.cpp index 019945dd..ed80b3a8 100644 --- a/src/uml/qumlvariableaction.cpp +++ b/src/uml/qumlvariableaction.cpp @@ -70,12 +70,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief VariableAction is an abstract class for actions that operate on a statically specified variable. + + \b {QUmlVariableAction is an abstract class.} */ + +/*! + Creates a new QUmlVariableAction. +*/ QUmlVariableAction::QUmlVariableAction() : _variable(0) { } +/*! + Returns a deep-copied clone of the QUmlVariableAction. +*/ QModelingElement *QUmlVariableAction::clone() const { QUmlVariableAction *c = new QUmlVariableAction; @@ -126,6 +135,9 @@ QUmlVariable *QUmlVariableAction::variable() const return _variable; } +/*! + Adjusts variable to \a variable. + */ void QUmlVariableAction::setVariable(QUmlVariable *variable) { // This is a read-write association end diff --git a/src/uml/qumlvariableaction.h b/src/uml/qumlvariableaction.h index 8ad36e68..96826015 100644 --- a/src/uml/qumlvariableaction.h +++ b/src/uml/qumlvariableaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlVariableAction) *) -QT_END_HEADER - #endif // QUMLVARIABLEACTION_H diff --git a/src/uml/qumlvertex.cpp b/src/uml/qumlvertex.cpp index fb4a9676..83ab8397 100644 --- a/src/uml/qumlvertex.cpp +++ b/src/uml/qumlvertex.cpp @@ -58,12 +58,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief A vertex is an abstraction of a node in a state machine graph. In general, it can be the source or destination of any number of transitions. + + \b {QUmlVertex is an abstract class.} */ + +/*! + Creates a new QUmlVertex. +*/ QUmlVertex::QUmlVertex() : _container(0) { } +/*! + Returns a deep-copied clone of the QUmlVertex. +*/ QModelingElement *QUmlVertex::clone() const { QUmlVertex *c = new QUmlVertex; @@ -84,6 +93,10 @@ QModelingElement *QUmlVertex::clone() const /*! The region that contains this vertex. + + \b {Subsetted property(ies):} QUmlNamedElement::namespace_(). + + \b {Opposite property(ies):} QUmlRegion::subvertices(). */ QUmlRegion *QUmlVertex::container() const { @@ -92,6 +105,9 @@ QUmlRegion *QUmlVertex::container() const return _container; } +/*! + Adjusts container to \a container. + */ void QUmlVertex::setContainer(QUmlRegion *container) { // This is a read-write association end @@ -110,6 +126,10 @@ void QUmlVertex::setContainer(QUmlRegion *container) /*! Specifies the transitions entering this vertex. + + \b {This is a read-only derived property.} + + \b {Opposite property(ies):} QUmlTransition::target(). */ const QSet<QUmlTransition *> QUmlVertex::incomings() const { @@ -120,6 +140,11 @@ const QSet<QUmlTransition *> QUmlVertex::incomings() const return QSet<QUmlTransition *>(); } +/*! + Adds \a incoming to incomings. + + \sa incomings(), removeIncoming() + */ void QUmlVertex::addIncoming(QUmlTransition *incoming) { // This is a read-only derived association end @@ -137,6 +162,11 @@ void QUmlVertex::addIncoming(QUmlTransition *incoming) } } +/*! + Removes \a incoming from incomings. + + \sa incomings(), addIncoming() + */ void QUmlVertex::removeIncoming(QUmlTransition *incoming) { // This is a read-only derived association end @@ -156,6 +186,10 @@ void QUmlVertex::removeIncoming(QUmlTransition *incoming) /*! Specifies the transitions departing from this vertex. + + \b {This is a read-only derived property.} + + \b {Opposite property(ies):} QUmlTransition::source(). */ const QSet<QUmlTransition *> QUmlVertex::outgoings() const { @@ -166,6 +200,11 @@ const QSet<QUmlTransition *> QUmlVertex::outgoings() const return QSet<QUmlTransition *>(); } +/*! + Adds \a outgoing to outgoings. + + \sa outgoings(), removeOutgoing() + */ void QUmlVertex::addOutgoing(QUmlTransition *outgoing) { // This is a read-only derived association end @@ -183,6 +222,11 @@ void QUmlVertex::addOutgoing(QUmlTransition *outgoing) } } +/*! + Removes \a outgoing from outgoings. + + \sa outgoings(), addOutgoing() + */ void QUmlVertex::removeOutgoing(QUmlTransition *outgoing) { // This is a read-only derived association end diff --git a/src/uml/qumlvertex.h b/src/uml/qumlvertex.h index e8b831f5..9d0ca688 100644 --- a/src/uml/qumlvertex.h +++ b/src/uml/qumlvertex.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlNamedElement> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -83,7 +81,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlVertex) *) -QT_END_HEADER - #endif // QUMLVERTEX_H diff --git a/src/uml/qumlwritelinkaction.cpp b/src/uml/qumlwritelinkaction.cpp index efbeb26d..1a36aea2 100644 --- a/src/uml/qumlwritelinkaction.cpp +++ b/src/uml/qumlwritelinkaction.cpp @@ -71,11 +71,20 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief WriteLinkAction is an abstract class for link actions that create and destroy links. + + \b {QUmlWriteLinkAction is an abstract class.} */ + +/*! + Creates a new QUmlWriteLinkAction. +*/ QUmlWriteLinkAction::QUmlWriteLinkAction() { } +/*! + Returns a deep-copied clone of the QUmlWriteLinkAction. +*/ QModelingElement *QUmlWriteLinkAction::clone() const { QUmlWriteLinkAction *c = new QUmlWriteLinkAction; diff --git a/src/uml/qumlwritelinkaction.h b/src/uml/qumlwritelinkaction.h index 8f996fcb..c46d75c2 100644 --- a/src/uml/qumlwritelinkaction.h +++ b/src/uml/qumlwritelinkaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlLinkAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -66,7 +64,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlWriteLinkAction) *) -QT_END_HEADER - #endif // QUMLWRITELINKACTION_H diff --git a/src/uml/qumlwritestructuralfeatureaction.cpp b/src/uml/qumlwritestructuralfeatureaction.cpp index 5f278e6a..f68231fa 100644 --- a/src/uml/qumlwritestructuralfeatureaction.cpp +++ b/src/uml/qumlwritestructuralfeatureaction.cpp @@ -70,13 +70,22 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief WriteStructuralFeatureAction is an abstract class for structural feature actions that change structural feature values. + + \b {QUmlWriteStructuralFeatureAction is an abstract class.} */ + +/*! + Creates a new QUmlWriteStructuralFeatureAction. +*/ QUmlWriteStructuralFeatureAction::QUmlWriteStructuralFeatureAction() : _result(0), _value(0) { } +/*! + Returns a deep-copied clone of the QUmlWriteStructuralFeatureAction. +*/ QModelingElement *QUmlWriteStructuralFeatureAction::clone() const { QUmlWriteStructuralFeatureAction *c = new QUmlWriteStructuralFeatureAction; @@ -125,6 +134,8 @@ QModelingElement *QUmlWriteStructuralFeatureAction::clone() const /*! Gives the output pin on which the result is put. + + \b {Subsetted property(ies):} QUmlAction::outputs(). */ QUmlOutputPin *QUmlWriteStructuralFeatureAction::result() const { @@ -133,6 +144,9 @@ QUmlOutputPin *QUmlWriteStructuralFeatureAction::result() const return _result; } +/*! + Adjusts result to \a result. + */ void QUmlWriteStructuralFeatureAction::setResult(QUmlOutputPin *result) { // This is a read-write association end @@ -155,6 +169,8 @@ void QUmlWriteStructuralFeatureAction::setResult(QUmlOutputPin *result) /*! Value to be added or removed from the structural feature. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlWriteStructuralFeatureAction::value() const { @@ -163,6 +179,9 @@ QUmlInputPin *QUmlWriteStructuralFeatureAction::value() const return _value; } +/*! + Adjusts value to \a value. + */ void QUmlWriteStructuralFeatureAction::setValue(QUmlInputPin *value) { // This is a read-write association end diff --git a/src/uml/qumlwritestructuralfeatureaction.h b/src/uml/qumlwritestructuralfeatureaction.h index 7823177d..c3922f73 100644 --- a/src/uml/qumlwritestructuralfeatureaction.h +++ b/src/uml/qumlwritestructuralfeatureaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlStructuralFeatureAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -76,7 +74,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlWriteStructuralFeatureAction) *) -QT_END_HEADER - #endif // QUMLWRITESTRUCTURALFEATUREACTION_H diff --git a/src/uml/qumlwritevariableaction.cpp b/src/uml/qumlwritevariableaction.cpp index 7f3344c9..d10d8b0a 100644 --- a/src/uml/qumlwritevariableaction.cpp +++ b/src/uml/qumlwritevariableaction.cpp @@ -70,12 +70,21 @@ QT_BEGIN_NAMESPACE \inmodule QtUml \brief WriteVariableAction is an abstract class for variable actions that change variable values. + + \b {QUmlWriteVariableAction is an abstract class.} */ + +/*! + Creates a new QUmlWriteVariableAction. +*/ QUmlWriteVariableAction::QUmlWriteVariableAction() : _value(0) { } +/*! + Returns a deep-copied clone of the QUmlWriteVariableAction. +*/ QModelingElement *QUmlWriteVariableAction::clone() const { QUmlWriteVariableAction *c = new QUmlWriteVariableAction; @@ -120,6 +129,8 @@ QModelingElement *QUmlWriteVariableAction::clone() const /*! Value to be added or removed from the variable. + + \b {Subsetted property(ies):} QUmlAction::inputs(). */ QUmlInputPin *QUmlWriteVariableAction::value() const { @@ -128,6 +139,9 @@ QUmlInputPin *QUmlWriteVariableAction::value() const return _value; } +/*! + Adjusts value to \a value. + */ void QUmlWriteVariableAction::setValue(QUmlInputPin *value) { // This is a read-write association end diff --git a/src/uml/qumlwritevariableaction.h b/src/uml/qumlwritevariableaction.h index 9ddf9683..981b1e09 100644 --- a/src/uml/qumlwritevariableaction.h +++ b/src/uml/qumlwritevariableaction.h @@ -45,8 +45,6 @@ #include <QtUml/QUmlVariableAction> -QT_BEGIN_HEADER - QT_BEGIN_NAMESPACE QT_MODULE(QtUml) @@ -72,7 +70,5 @@ QT_END_NAMESPACE Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE(QUmlWriteVariableAction) *) -QT_END_HEADER - #endif // QUMLWRITEVARIABLEACTION_H |