Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/org.eclipse.etrice.core.fsm/src/org/eclipse/etrice/core/fsm/postprocessing/DocuPostprocessor.xtend')
-rw-r--r--plugins/org.eclipse.etrice.core.fsm/src/org/eclipse/etrice/core/fsm/postprocessing/DocuPostprocessor.xtend52
1 files changed, 52 insertions, 0 deletions
diff --git a/plugins/org.eclipse.etrice.core.fsm/src/org/eclipse/etrice/core/fsm/postprocessing/DocuPostprocessor.xtend b/plugins/org.eclipse.etrice.core.fsm/src/org/eclipse/etrice/core/fsm/postprocessing/DocuPostprocessor.xtend
index cd4a71e71..f874466f7 100644
--- a/plugins/org.eclipse.etrice.core.fsm/src/org/eclipse/etrice/core/fsm/postprocessing/DocuPostprocessor.xtend
+++ b/plugins/org.eclipse.etrice.core.fsm/src/org/eclipse/etrice/core/fsm/postprocessing/DocuPostprocessor.xtend
@@ -519,6 +519,58 @@ class DocuPostprocessor {
This is a guard condition specified in the code generator's target language.
It has to evaluate to a boolean value.
''')
+
+ //------------------------------------------------------------------
+ cls = pckg.getClass("ProtocolSemantics")
+ cls.setDocumentation('''
+ An optional semantics specification as part of a {@link ProtocolClass}.
+ The semantic is defined as a <em>legal execution tree</em>.
+ This tree is composed of incoming and outgoing messages and each path through
+ this tree is a valid sequence of messages exchanged through a port instance.
+
+ <p>
+ The semantics are composed using {@link SemanticsRule}s.
+ </p>
+ ''')
+
+ cls.getReference("rules").setDocumentation(
+ '''
+ This is a list of semantic rules.
+ ''')
+
+ //------------------------------------------------------------------
+ cls = pckg.getClass("SemanticsRule")
+ cls.setDocumentation('''
+ The super class of
+ <ul>
+ <li>{@link InSemanticsRule}</li>
+ <li>{@link OutSemanticsRule}</li>
+ </ul>
+ ''')
+
+ cls.getReference("msg").setDocumentation(
+ '''
+ The message to which this rule applies.
+ ''')
+
+ cls.getReference("followUps").setDocumentation(
+ '''
+ The possible follow up rules.
+ ''')
+
+ //------------------------------------------------------------------
+ cls = pckg.getClass("InSemanticsRule")
+ cls.setDocumentation('''
+ A {@link SemanticsRule} for incoming messages.
+ The rule points to an incoming messages and allows follow-up rules.
+ ''')
+
+ //------------------------------------------------------------------
+ cls = pckg.getClass("OutSemanticsRule")
+ cls.setDocumentation('''
+ A {@link SemanticsRule} for outgoing messages.
+ The rule points to an outgoing messages and allows follow-up rules.
+ ''')
}

Back to the top