updated documentation about IEngineAddon interface

contributes to #151 Signed-off-by: Didier Vojtisek <[email protected]>
eclipse-gemoc · Jan 31, 2020 · 8998630 · 8998630
1 parent ec940d7
commit 8998630
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/framework/execution_framework/docs/dev/images/dev/ExecutionEngine_Typical_flow_SD.plantuml b/framework/execution_framework/docs/dev/images/dev/ExecutionEngine_Typical_flow_SD.plantuml
@@ -35,6 +35,11 @@ deactivate Launcher
 deactivate Launcher
 
 Engine --> addon : engineAboutToStart
+note right
+	if required, the order of the calls to the Addons 
+	can be controled by defining 
+	EngineAddonSortingRules in the Addons
+end note
 Engine -> Engine : beforeStart
 Engine --> addon : engineStarted
 Engine -> Engine : performStart

diff --git a/framework/framework_commons/docs/dev/FrameworkCommons.asciidoc b/framework/framework_commons/docs/dev/FrameworkCommons.asciidoc
@@ -24,3 +24,5 @@ Most notably, the _IEngineAddon_ and _IExecutionEngine_ interfaces that are the
 image::images/dev/frameworkcommons_api_overview_CD.png["Execution Framework API Interfaces overview"]
 
 
+TIP: The section <<dev-new-addons>> contains some details and code snippets about how to write an engine addon.
+
diff --git a/...dsmlframework.api/src/org/eclipse/gemoc/xdsmlframework/api/engine_addon/IEngineAddon.java b/...dsmlframework.api/src/org/eclipse/gemoc/xdsmlframework/api/engine_addon/IEngineAddon.java
@@ -113,7 +113,7 @@ default public List<String> getTags() {
 	 * A given rule indicate when to call the current addon relatively to addons referred by the rule
 	 * @return
 	 */
-	default public List<EngineAddonSortingRule> getAddonSortingRules(){
+	default public List<EngineAddonSortingRule> getAddonSortingRules() {
 		return new ArrayList<EngineAddonSortingRule>();
 	}