From e7cd7451c7ab15891cac6ce868572674d16e1fcd Mon Sep 17 00:00:00 2001
From: Simon Barner <barner@fortiss.org>
Date: Wed, 4 Jul 2018 09:27:36 +0200
Subject: [PATCH] Cleanup documentation
Issue-Ref: 3401
Issue-Url: https://af3-developer.fortiss.org/issues/3401
Signed-off-by: Simon Barner <barner@fortiss.org>
---
org.fortiss.tooling.base/model/.ratings | 2 +-
org.fortiss.tooling.base/model/base.ecore | 58 +++----------------
.../org/fortiss/tooling/base/compose/.ratings | 2 +-
...ConstraintInstanceContainerCompositor.java | 3 +-
4 files changed, 11 insertions(+), 54 deletions(-)
diff --git a/org.fortiss.tooling.base/model/.ratings b/org.fortiss.tooling.base/model/.ratings
index a010f8f18..96ee5de9b 100644
--- a/org.fortiss.tooling.base/model/.ratings
+++ b/org.fortiss.tooling.base/model/.ratings
@@ -1 +1 @@
-base.ecore c656c35978afc6ea540440c2f47f45d360cc35b6 RED
+base.ecore 19a26967b400af3ef306101bcc1fb82f662d7a9f RED
diff --git a/org.fortiss.tooling.base/model/base.ecore b/org.fortiss.tooling.base/model/base.ecore
index c656c3597..19a26967b 100644
--- a/org.fortiss.tooling.base/model/base.ecore
+++ b/org.fortiss.tooling.base/model/base.ecore
@@ -149,7 +149,7 @@
<eClassifiers xsi:type="ecore:EDataType" name="IModelElementSpecificationArray"
instanceClassName="org.fortiss.tooling.base.model.element.IModelElementSpecification[]">
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="An array of model element specifications."/>
+ <details key="documentation" value="@deprecated An array of model element specifications."/>
</eAnnotations>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="IDerivedAnnotation" abstract="true"
@@ -192,40 +192,20 @@
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
<details key="documentation" value="Marker interface for metaclasses to describe constraint-based development processes.

TODO: Clarify relation to constraint metaclasses in tooling.kernel."/>
</eAnnotations>
- <eStructuralFeatures xsi:type="ecore:EReference" name="currentObjective" eType="#//element/ConstraintConfiguration">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
- </eStructuralFeatures>
+ <eStructuralFeatures xsi:type="ecore:EReference" name="currentObjective" eType="#//element/ConstraintConfiguration"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="constraintInstanceContainer"
- eType="ecore:EClass platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//constraints/IConstraintInstanceContainer">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
- </eStructuralFeatures>
+ eType="ecore:EClass platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//constraints/IConstraintInstanceContainer"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="configurations" upperBound="-1"
- eType="#//element/ConstraintConfiguration" containment="true">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
- </eStructuralFeatures>
+ eType="#//element/ConstraintConfiguration" containment="true"/>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="ConstraintConfiguration" eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//INamedElement">
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
<details key="documentation" value="Hierarchical description of constraint configuration.

TODO: Clarify relation to constraint metaclasses in tooling.kernel."/>
</eAnnotations>
<eStructuralFeatures xsi:type="ecore:EAttribute" name="activeConstraints" upperBound="-1"
- eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
- </eStructuralFeatures>
+ eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="includedConfigurations"
- upperBound="-1" eType="#//element/ConstraintConfiguration">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
- </eStructuralFeatures>
+ upperBound="-1" eType="#//element/ConstraintConfiguration"/>
</eClassifiers>
</eSubpackages>
<eSubpackages name="layout" nsURI="http://www.fortiss.org/tooling/base/model/layout"
@@ -523,32 +503,22 @@
</eAnnotations>
<eStructuralFeatures xsi:type="ecore:EReference" name="dimensions" lowerBound="1"
upperBound="-1" containment="true">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
<eGenericType eClassifier="#//visualization/Dimension">
<eTypeArguments eClassifier="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EJavaObject"/>
</eGenericType>
</eStructuralFeatures>
<eStructuralFeatures xsi:type="ecore:EReference" name="axes" lowerBound="1"
upperBound="-1" containment="true">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
<eGenericType eClassifier="#//visualization/Axis">
<eTypeArguments eClassifier="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EJavaObject"/>
</eGenericType>
</eStructuralFeatures>
<eStructuralFeatures xsi:type="ecore:EReference" name="sets" lowerBound="1"
- upperBound="-1" eType="#//visualization/DataSet" containment="true">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
- </eStructuralFeatures>
+ upperBound="-1" eType="#//visualization/DataSet" containment="true"/>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="DataSet" eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//INamedCommentedElement">
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="A collection of visualization {@link Point}s."/>
+ <details key="documentation" value="A collection of visualization {@link DataPoint}s."/>
</eAnnotations>
<eStructuralFeatures xsi:type="ecore:EReference" name="points" lowerBound="1"
upperBound="-1" containment="true">
@@ -563,29 +533,17 @@
</eAnnotations>
<eTypeParameters name="T"/>
<eStructuralFeatures xsi:type="ecore:EAttribute" name="start">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
<eGenericType eTypeParameter="#//visualization/DataPoint/T"/>
</eStructuralFeatures>
<eStructuralFeatures xsi:type="ecore:EAttribute" name="end">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
<eGenericType eTypeParameter="#//visualization/DataPoint/T"/>
</eStructuralFeatures>
<eStructuralFeatures xsi:type="ecore:EReference" name="axis">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
<eGenericType eClassifier="#//visualization/Axis">
<eTypeArguments eTypeParameter="#//visualization/DataPoint/T"/>
</eGenericType>
</eStructuralFeatures>
<eStructuralFeatures xsi:type="ecore:EReference" name="dimension">
- <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
- <details key="documentation" value="TODO: write documentation (in the model!)"/>
- </eAnnotations>
<eGenericType eClassifier="#//visualization/Dimension">
<eTypeArguments eTypeParameter="#//visualization/DataPoint/T"/>
</eGenericType>
diff --git a/org.fortiss.tooling.base/src/org/fortiss/tooling/base/compose/.ratings b/org.fortiss.tooling.base/src/org/fortiss/tooling/base/compose/.ratings
index fb899f438..96df04458 100644
--- a/org.fortiss.tooling.base/src/org/fortiss/tooling/base/compose/.ratings
+++ b/org.fortiss.tooling.base/src/org/fortiss/tooling/base/compose/.ratings
@@ -1,7 +1,7 @@
ConnectionCompositorBase.java 692689b535d7136acab2ab67a015f70809e64b6b GREEN
ConnectorConnectionCompositorBase.java 2c710349fe98f09004521fa68586c020499d6275 GREEN
ConnectorHierarchicElementConnectionCompositorBase.java 6a35ca0237ded34169a5b601b5928f1ba58ef6bc GREEN
-ConstraintInstanceContainerCompositor.java 63cec234423a8b7766b1ea398cffe3f3e2050f3c GREEN
+ConstraintInstanceContainerCompositor.java 85cee7a6e0dfaf087a13b76069d8acfac7589bef GREEN
HierarchicElementCompositorBase.java e96b8a5a2cdb946f135edb2c2248a476e2f870ef GREEN
HierarchicElementConnectionCompositorBase.java 08e315fed95d7c45ad5f00b3258fd13b811dbcfb GREEN
HierarchicElementConnectorConnectionCompositorBase.java eba2318c219f796c73ac0ad0344088298c268eb9 GREEN
diff --git a/org.fortiss.tooling.base/src/org/fortiss/tooling/base/compose/ConstraintInstanceContainerCompositor.java b/org.fortiss.tooling.base/src/org/fortiss/tooling/base/compose/ConstraintInstanceContainerCompositor.java
index 63cec2344..85cee7a6e 100644
--- a/org.fortiss.tooling.base/src/org/fortiss/tooling/base/compose/ConstraintInstanceContainerCompositor.java
+++ b/org.fortiss.tooling.base/src/org/fortiss/tooling/base/compose/ConstraintInstanceContainerCompositor.java
@@ -19,7 +19,6 @@ import static org.eclipse.emf.ecore.util.EcoreUtil.delete;
import static org.fortiss.tooling.base.utils.ConstraintsBaseUtils.removeFromConstraintInstanceContainer;
import org.eclipse.emf.ecore.EObject;
-import org.fortiss.tooling.base.model.base.ConstraintInstanceContainer;
import org.fortiss.tooling.kernel.extension.IElementCompositor;
import org.fortiss.tooling.kernel.extension.data.IElementCompositionContext;
import org.fortiss.tooling.kernel.extension.data.Prototype;
@@ -27,7 +26,7 @@ import org.fortiss.tooling.kernel.model.constraints.ConstraintInstance;
import org.fortiss.tooling.kernel.model.constraints.IConstraintInstanceContainer;
/**
- * {@link IElementCompositor} implementation for {@link ConstraintInstanceContainer}s.
+ * {@link IElementCompositor} implementation for {@link IConstraintInstanceContainer}s.
*
* @author hoelzl
*/
--
GitLab