Commit ac7aef58 authored by Simon Barner's avatar Simon Barner
Browse files

RED

* Missing documentation for some MM classes
* Add note about deprecated annotation

Issue-Ref: 3524
Issue-Url: https://af3-developer.fortiss.org/issues/3524

Signed-off-by: Simon Barner's avatarSimon Barner <barner@fortiss.org>
parent 890830a3
documentation.html ee0b0297e0426a3f764015999de7ff44a52ed66e YELLOW
documentation.html ef938699104acc60c6b14e6cfc5ade3a32b51d94 RED
......@@ -75,15 +75,17 @@ one port to another.</li>
<li><tt>LibraryComponentPackage</tt>: represents a package of library components.</li>
<li><tt>PropagatableSpecification</tt>: describes how data can be propagated from one port to another.</li>
<li><tt>VerifBehaviourComponentSpecification</tt>: interface implementing methods, which allow to get the specifications of a component and to verify its behavior.</li>
<li><tt>InternalComponent</tt></li>
<li><tt>ComponentSpecificationsContainer</tt></li>
<li><tt>IReadOnlyBehaviorSpecification</tt></li>
<li><tt>InternalComponent</tt>: TODO</li>
<li><tt>ComponentSpecificationsContainer</tt>: TODO</li>
<li><tt>IReadOnlyBehaviorSpecification</tt>: TODO</li>
</ul>
The sub-package <i>annotation</i> contains:
<ul>
<li><tt>MemoryRequirement</tt>: annotation that returns the estimated memory requirement of a
component, i.e. the sum of its local memory requirement plus the memory requirements of its children.</li>
component, i.e. the sum of its local memory requirement plus the memory requirements of its children.
</br><b>Note</b>: This annotation is deprecated. See <tt>RamRequirement</tt> in
<a href="../../../org.fortiss.af3.task/html/developer/documentation.html">task architecture</a> instead.</li>
</ul>
The sub-package <i>behavior</i> contains:
......@@ -95,7 +97,7 @@ automaton. Valid types are int, double and boolean.</li>
from one state to another.</li>
<li><tt>common.Action</tt>: used in a state automaton to create an assignment expression inside
of a state, which means to create an action when this state is achieved.</li>
<li><tt>common.IDataStateVariableProvider</tt></li>
<li><tt>common.IDataStateVariableProvider</tt>: TODO</li>
<li><tt>code.CodeSpecification</tt>: a way to provide behavior to a component by means of writing a
c-like code directly in the body of a component.</li>
</ul>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment