Add missing 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

-base.ecore 439979ff2434a8162f78d49c596bc6da9f70cda2 RED
+base.ecore 3d98f771fef61c067b2722c1bdf401f5b533ce37 RED

org.fortiss.tooling.base/model/base.ecore

@@ -189,17 +189,43 @@
     </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="IConstraintBasedProcess" abstract="true"
         interface="true">
-      <eStructuralFeatures xsi:type="ecore:EReference" name="currentObjective" eType="#//element/ConstraintConfiguration"/>
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Marker interface for metaclasses to describe constraint-based development processes."/>
+      </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="constraintInstanceContainer"
-          eType="ecore:EClass platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//constraints/IConstraintInstanceContainer"/>
+          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>
       <eStructuralFeatures xsi:type="ecore:EReference" name="configurations" upperBound="-1"
-          eType="#//element/ConstraintConfiguration" containment="true"/>
+          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>
     </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."/>
+      </eAnnotations>
       <eStructuralFeatures xsi:type="ecore:EAttribute" name="activeConstraints" upperBound="-1"
-          eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
+          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>
       <eStructuralFeatures xsi:type="ecore:EReference" name="includedConfigurations"
-          upperBound="-1" eType="#//element/ConstraintConfiguration"/>
+          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>
     </eClassifiers>
   </eSubpackages>
   <eSubpackages name="layout" nsURI="http://www.fortiss.org/tooling/base/model/layout"
@@ -404,15 +430,38 @@
   <eSubpackages name="base" nsURI="http://www.fortiss.org/tooling/base/model/base"
       nsPrefix="org-fortiss-tooling-base-model-base">
     <eClassifiers xsi:type="ecore:EClass" name="HierarchicElementBase" abstract="true"
-        eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//INamedCommentedElement #//element/IHierarchicElement #//layout/ILayoutedModelElement"/>
-    <eClassifiers xsi:type="ecore:EClass" name="ConnectorBase" abstract="true" eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//INamedCommentedElement #//element/IConnector #//layout/ILayoutedModelElement"/>
+        eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//INamedCommentedElement #//element/IHierarchicElement #//layout/ILayoutedModelElement">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Base class for {@link IHierarchicElement}s."/>
+      </eAnnotations>
+    </eClassifiers>
+    <eClassifiers xsi:type="ecore:EClass" name="ConnectorBase" abstract="true" eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//INamedCommentedElement #//element/IConnector #//layout/ILayoutedModelElement">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Base class for {@link IConnector}s."/>
+      </eAnnotations>
+    </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="EntryConnectorBase" abstract="true"
-        eSuperTypes="#//base/ConnectorBase"/>
+        eSuperTypes="#//base/ConnectorBase">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Base class for entry connectors."/>
+      </eAnnotations>
+    </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="ExitConnectorBase" abstract="true"
-        eSuperTypes="#//base/ConnectorBase"/>
+        eSuperTypes="#//base/ConnectorBase">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Base class for exit connectors."/>
+      </eAnnotations>
+    </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="ConnectionSegmentBase" abstract="true"
-        eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//INamedCommentedElement #//element/IConnection #//layout/ILayoutedModelElement"/>
+        eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//INamedCommentedElement #//element/IConnection #//layout/ILayoutedModelElement">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Base class for {@link IConnector}s."/>
+      </eAnnotations>
+    </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="LibraryElementBase" eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//ILibraryElement">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Base class for {@link ILibraryElement}s."/>
+      </eAnnotations>
       <eOperations name="getURI" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString">
         <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
           <details key="body" value="return LibraryElementBaseStaticImpl.getURI(this);"/>
@@ -425,6 +474,9 @@
       </eOperations>
     </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="DerivedAnnotationBase" abstract="true">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Base class for {@link IDerivedAnnotation}s."/>
+      </eAnnotations>
       <eTypeParameters name="T"/>
       <eOperations name="getValue">
         <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
@@ -453,27 +505,47 @@
       </eGenericSuperTypes>
     </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="ConstraintInstanceContainer" eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//constraints/IConstraintInstanceContainer"/>
-    <eClassifiers xsi:type="ecore:EClass" name="ConstraintBasedProcess" eSuperTypes="#//element/IConstraintBasedProcess"/>
+    <eClassifiers xsi:type="ecore:EClass" name="ConstraintBasedProcess" eSuperTypes="#//element/IConstraintBasedProcess">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Base class for {@link IConstraintBasedProcess}es."/>
+      </eAnnotations>
+    </eClassifiers>
   </eSubpackages>
   <eSubpackages name="visualization" nsURI="http://www.fortiss.org/tooling/base/model/visualization"
       nsPrefix="org-fortiss-tooling-base-model-visualization">
     <eClassifiers xsi:type="ecore:EClass" name="DataSetCollection" 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 DataSet}s."/>
+      </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"/>
+          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>
     </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."/>
+      </eAnnotations>
       <eStructuralFeatures xsi:type="ecore:EReference" name="points" lowerBound="1"
           upperBound="-1" containment="true">
         <eGenericType eClassifier="#//visualization/DataPoint">
@@ -482,28 +554,49 @@
       </eStructuralFeatures>
     </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="DataPoint" 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 single data point to be visualized."/>
+      </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>
       </eStructuralFeatures>
     </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="Axis" eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//INamedCommentedElement">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Axis of a {@link DataPoint}."/>
+      </eAnnotations>
       <eTypeParameters name="T"/>
     </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="Dimension" eSuperTypes="platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//INamedCommentedElement">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Dimension of a {@link DataPoint}."/>
+      </eAnnotations>
       <eTypeParameters name="T"/>
     </eClassifiers>
   </eSubpackages>

org.fortiss.tooling.kernel/model/.ratings

-kernel.ecore a3f40ae6837a02c8d7406e30c5cbe4deae60d596 RED
+kernel.ecore 2fc8ecb347d3ca168852534d911c52ceb5492117 RED

org.fortiss.tooling.kernel/model/kernel.ecore

@@ -73,7 +73,11 @@
     <eStructuralFeatures xsi:type="ecore:EAttribute" name="URI" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
   </eClassifiers>
   <eClassifiers xsi:type="ecore:EClass" name="ILibraryRootElement" abstract="true"
-      interface="true" eSuperTypes="#//INamedCommentedElement"/>
+      interface="true" eSuperTypes="#//INamedCommentedElement">
+    <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+      <details key="documentation" value="Root element of model element library."/>
+    </eAnnotations>
+  </eClassifiers>
   <eClassifiers xsi:type="ecore:EClass" name="ILibrary" abstract="true" interface="true"
       eSuperTypes="#//INamedCommentedElement">
     <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
@@ -84,22 +88,43 @@
   </eClassifiers>
   <eClassifiers xsi:type="ecore:EClass" name="IElementWithURI" abstract="true" interface="true">
     <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
-      <details key="documentation" value="ILibraryElement is the super class of all elements contained in a library."/>
+      <details key="documentation" value="ILibraryElements that can be referenced using a URI."/>
     </eAnnotations>
     <eOperations name="getURI" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
   </eClassifiers>
   <eClassifiers xsi:type="ecore:EClass" name="ILibraryPackage" abstract="true" interface="true"
       eSuperTypes="#//IElementWithURI #//INamedCommentedElement">
+    <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+      <details key="documentation" value="Package (folder) to hiearchically organize ILibrarys."/>
+    </eAnnotations>
     <eStructuralFeatures xsi:type="ecore:EReference" name="subPackages" upperBound="-1"
-        eType="#//ILibraryPackage" containment="true"/>
+        eType="#//ILibraryPackage" containment="true">
+      <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="libraryElements" upperBound="-1"
-        eType="#//ILibraryElement" containment="true"/>
+        eType="#//ILibraryElement" containment="true">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="TODO: write documentation (in the model!)"/>
+      </eAnnotations>
+    </eStructuralFeatures>
   </eClassifiers>
   <eClassifiers xsi:type="ecore:EClass" name="IExternalDocumentReference">
-    <eStructuralFeatures xsi:type="ecore:EAttribute" name="uri" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
+    <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+      <details key="documentation" value="Reference to an external document."/>
+    </eAnnotations>
+    <eStructuralFeatures xsi:type="ecore:EAttribute" name="uri" 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>
   </eClassifiers>
   <eClassifiers xsi:type="ecore:EClass" name="ISpeciallyCopyiable" abstract="true"
       interface="true">
+    <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+      <details key="documentation" value="Interface to hook code to handle special cases for copy and paste."/>
+    </eAnnotations>
     <eOperations name="specialCopyHook">
       <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
         <details key="documentation" value="Hook for the copy of elements which need a special treatement (e.g, copy of connections, avoiding the repetition of some characteristics due to a copy, etc.)"/>
@@ -152,16 +177,38 @@
       </eOperations>
     </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="OutdatedConstraintInstanceStatus"
-        eSuperTypes="#//constraints/IConstraintInstanceStatus"/>
-    <eClassifiers xsi:type="ecore:EClass" name="FailedConstraintInstanceStatus" eSuperTypes="#//constraints/IConstraintInstanceStatus"/>
-    <eClassifiers xsi:type="ecore:EClass" name="ErrorConstraintInstanceStatus" eSuperTypes="#//constraints/IConstraintInstanceStatus"/>
-    <eClassifiers xsi:type="ecore:EClass" name="SuccessConstraintInstanceStatus" eSuperTypes="#//constraints/IConstraintInstanceStatus"/>
+        eSuperTypes="#//constraints/IConstraintInstanceStatus">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Status that indicates that the verification of a constraint is outdated."/>
+      </eAnnotations>
+    </eClassifiers>
+    <eClassifiers xsi:type="ecore:EClass" name="FailedConstraintInstanceStatus" eSuperTypes="#//constraints/IConstraintInstanceStatus">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Status that indicates that the verification of a constraint has failed."/>
+      </eAnnotations>
+    </eClassifiers>
+    <eClassifiers xsi:type="ecore:EClass" name="ErrorConstraintInstanceStatus" eSuperTypes="#//constraints/IConstraintInstanceStatus">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Status that indicates that an error has occurred during the verification of a constraint."/>
+      </eAnnotations>
+    </eClassifiers>
+    <eClassifiers xsi:type="ecore:EClass" name="SuccessConstraintInstanceStatus" eSuperTypes="#//constraints/IConstraintInstanceStatus">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Status that indicates that a constraint has succesfully been verified."/>
+      </eAnnotations>
+    </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="IConstraintInstanceContainer" abstract="true"
         interface="true">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Container to group multiple constraint instances."/>
+      </eAnnotations>
       <eStructuralFeatures xsi:type="ecore:EReference" name="constraintInstances"
           upperBound="-1" eType="#//constraints/ConstraintInstance" containment="true"/>
     </eClassifiers>
     <eClassifiers xsi:type="ecore:EClass" name="ConstraintNameToChecksum" instanceClassName="java.util.Map$Entry">
+      <eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
+        <details key="documentation" value="Map type to map constraint names to checksum values."/>
+      </eAnnotations>
       <eStructuralFeatures xsi:type="ecore:EAttribute" name="key" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
       <eStructuralFeatures xsi:type="ecore:EAttribute" name="value" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EBigInteger"/>
     </eClassifiers>