Skip to content
Snippets Groups Projects
Commit 82bcc77e authored by Simon Barner's avatar Simon Barner
Browse files

- Documentation fixes (no functional change)

parent 901559a4
No related branches found
No related tags found
No related merge requests found
......@@ -113,7 +113,7 @@
<eClassifiers xsi:type="ecore:EClass" name="IConnection" abstract="true" interface="true"
eSuperTypes="#//element/IModelElement">
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
<details key="documentation" value="Super class of connections. Connections are aggregated in a hierarchic model element and reference two connectors from that element or any direct sub-elenent."/>
<details key="documentation" value="Super class of connections. Connections are aggregated in a hierarchic model element and reference two connectors from that element or any direct sub-element."/>
</eAnnotations>
<eStructuralFeatures xsi:type="ecore:EReference" name="source" eType="#//element/IConnector"
eOpposite="#//element/IConnector/outgoing">
......@@ -143,7 +143,7 @@
<eClassifiers xsi:type="ecore:EClass" name="IAnnotatedSpecification" abstract="true"
interface="true" eSuperTypes="#//element/IModelElementSpecification platform:/resource/org.fortiss.tooling.kernel/model/kernel.ecore#//INamedElement">
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
<details key="documentation" value="Super class of hidden model element specifications that represent annotations."/>
<details key="documentation" value="Super class of model element specifications that represent annotations (i.e., specifications that are guaranteed to exist exactly once for the model elements for which the annotation has been registered)"/>
</eAnnotations>
</eClassifiers>
<eClassifiers xsi:type="ecore:EDataType" name="IModelElementSpecificationArray"
......@@ -155,12 +155,12 @@
<eClassifiers xsi:type="ecore:EClass" name="IDerivedAnnotation" abstract="true"
interface="true" eSuperTypes="#//element/IAnnotatedSpecification #//element/IHiddenSpecification">
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
<details key="documentation" value="Interface for {@link IAnnotationSpecification}s that are derived from the state of other annotations and/or model elements.&#xD;&#xA;&#xD;&#xA;&lt;ul>&#xD;&#xA;&lt;li>Concrete specifications must provide a specialized getValue() {@link EOperation}s that perform the required calculation. Example: Calculation of {@link Component} WCET for current deployment (if available) based on {@link Component} instruction count and performance (e.g., MIPS) of {@link ExecutionUnit}, some warning indicator otherwise. &lt;/li>&#xD;&#xA;&lt;li>Concrete specifications may provide additional {@link EOperation} that provide an advanced query interface to the annoation. Example: WCET for an explicitly specified {@link ExecutionUnit}. This can be used e.g. in a DSE to explore different deployments.&lt;/li>&#xD;&#xA;&lt;li>The corresponding {@link IAnnotationValueProvider} should be based on {@link DerivedAnnotationValueProviderBase}.&#xD;&#xA;&lt;/ul>"/>
<details key="documentation" value="Interface for {@link IAnnotationSpecification}s that are derived from the state of other annotations and/or model elements.&#xD;&#xA;&#xD;&#xA;&lt;ul>&#xD;&#xA;&lt;li>Concrete specifications must provide a specialized getValue() {@link EOperation}s that perform the required calculation. Example: Calculation of {@link Component} WCET for current deployment (if available) based on {@link Component} instruction count and performance (e.g., MIPS) of {@link ExecutionUnit}, some warning indicator otherwise. &lt;/li>&#xD;&#xA;&lt;li>Concrete specifications may provide additional {@link EOperation} that provide an advanced query interface to the annotation. Example: WCET for an explicitly specified {@link ExecutionUnit}. This can be used e.g. in a DSE to explore different deployments.&lt;/li>&#xD;&#xA;&lt;li>The corresponding {@link IAnnotationValueProvider} should be based on {@link DerivedAnnotationValueProviderBase}.&#xD;&#xA;&lt;/ul>"/>
</eAnnotations>
<eTypeParameters name="T"/>
<eOperations name="getValue">
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
<details key="documentation" value="Wrapper method for returning derived (calculated) values. It may return values annotated by the user if the calculation fails, or the user input is preffered, based on the configuration of the concrete annotation. "/>
<details key="documentation" value="Wrapper method for returning derived (calculated) values. It may return values annotated by the user if the calculation fails, or the user input is preferred, based on the configuration of the concrete annotation. "/>
<details key="body" value="if(getUserAnnotatedValue() != null &amp;&amp; (isUserAnnotatedValuePreferred() || getDerivedValue() == null)) {return getUserAnnotatedValue();} return getDerivedValue();"/>
</eAnnotations>
<eGenericType eTypeParameter="#//element/IDerivedAnnotation/T"/>
......@@ -179,13 +179,13 @@
</eOperations>
<eOperations name="isUserAnnotatedValuePreferred" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EBoolean">
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
<details key="documentation" value="Default implementation of a method indicating whether the user annotated value, if available, shall be preferred over the derived one. The default is 'true', i.e. user annotated values are preferred. Shall be overridden, if another bahaviour is desired."/>
<details key="documentation" value="Default implementation of a method indicating whether the user annotated value, if available, shall be preferred over the derived one. The default is 'true', i.e. user annotated values are preferred. Shall be overridden, if another behavior is desired."/>
<details key="body" value="return true;"/>
</eAnnotations>
</eOperations>
<eOperations name="getUserAnnotatedValue">
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
<details key="documentation" value="Returns the {@link EAttribute} which is used to store the user annotated values, if the concrete annotatin is designed therefore. By default, this function returns null, indicating no user annotated values are supported. This method must be re-implemented by concrete annotations if any other behavior is desired."/>
<details key="documentation" value="Returns the {@link EAttribute} which is used to store the user annotated values, if the concrete annotation is designed therefore. By default, this function returns null, indicating no user annotated values are supported. This method must be re-implemented by concrete annotations if any other behavior is desired."/>
</eAnnotations>
<eGenericType eTypeParameter="#//element/IDerivedAnnotation/T"/>
</eOperations>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment