瀏覽代碼

Added documentation of generated Java code.

markus.muehlbrandt@gmail.com 12 年之前
父節點
當前提交
ad339f40fc

+ 2 - 0
plugins/org.yakindu.sct.doc.developer/help/03_Concepts/concepts.textile

@@ -19,6 +19,8 @@ You find the generated code in the 'src-gen' folder of the traffic light example
 
 In the package 'org.yakindu.sct.examples.trafficlight.cyclebased' are the most basic statemachine interfaces and classes located. These are needed by each statemachine and are independend from the concrete statemachine design.
 
+h4. Interface IStatemachine
+
 The interface @IStatemachine@ is implemented by each generated statemachine:
 
 

+ 3 - 9
plugins/org.yakindu.sct.doc.user/build.xml

@@ -25,15 +25,9 @@
 -->
 	<target name="generate.help" description="Runs the Eclipse help generator on the listed wiki source files">
 		<generate.section.help src.dir="${help.dir}/01_Overview" src.file="overview.textile" prefix="${help.prefix}/01_Overview" />
-		<generate.section.help src.dir="${help.dir}/user/02_Getting_Started" src.file="getting_started.textile" prefix="${help.prefix}/user/02_Getting_Started" />
-		<generate.section.help src.dir="${help.dir}/user/03_Concepts" src.file="concepts.textile" prefix="${help.prefix}/user/03_Concepts"/>
-		<generate.section.help src.dir="${help.dir}/user/04_Tasks" src.file="tasks.textile" prefix="${help.prefix}/user/04_Tasks" />
-		<generate.section.help src.dir="${help.dir}/user/05_Reference" src.file="reference.textile" prefix="${help.prefix}/user/05_Reference" />
-		<generate.section.help src.dir="${help.dir}/developer/01_Overview" src.file="overview.textile" prefix="${help.prefix}/developer/01_Overview" />
-		<generate.section.help src.dir="${help.dir}/developer/02_Getting_Started" src.file="getting_started.textile" prefix="${help.prefix}/developer/02_Getting_Started" />
-		<generate.section.help src.dir="${help.dir}/developer/03_Concepts" src.file="concepts.textile" prefix="${help.prefix}/developer/03_Concepts"/>
-		<generate.section.help src.dir="${help.dir}/developer/04_Tasks" src.file="tasks.textile" prefix="${help.prefix}/developer/04_Tasks" />
-		<generate.section.help src.dir="${help.dir}/developer/05_Reference" src.file="reference.textile" prefix="${help.prefix}/developer/05_Reference" />
+		<generate.section.help src.dir="${help.dir}/02_Getting_started" src.file="getting_started.textile" prefix="${help.prefix}/user/02_Getting_Started" />
+		<generate.section.help src.dir="${help.dir}/03_Tasks" src.file="tasks.textile" prefix="${help.prefix}/user/03_Tasks" />
+		<generate.section.help src.dir="${help.dir}/04_Reference" src.file="reference.textile" prefix="${help.prefix}/user/04_Reference" />
 	</target>
 
 	<target name="clean">

+ 1 - 1
plugins/org.yakindu.sct.doc.user/help/01_Overview/overview.html

@@ -6,7 +6,7 @@
 		<link type="text/css" rel="stylesheet" href="../style.css"/>
 	</head>
 	<body>
-		<p><link href="../../css/bootstrap.css" rel="stylesheet" /></p>
+		<p><link href="../css/bootstrap.css" rel="stylesheet" /></p>
 		<h1 id="Overview">Overview</h1>
 		<h2 id="WhataretheYAKINDUStatechartTools2">What are the YAKINDU Statechart Tools 2</h2>
 		<p>The statechart tools are one central part of YAKINDU: the modular toolkit for model driven development of embedded systems. It is based on the open source development platform Eclipse. The YAKINDU Statechart tools provide the following tools to deal with state machine diagramms:</p>

+ 12 - 12
plugins/org.yakindu.sct.doc.user/help/02_Getting_started/getting_started-toc.xml

@@ -1,15 +1,15 @@
 <?xml version='1.0' encoding='utf-8' ?>
-<toc topic="help/02_Getting_started/getting_started.html" label="getting_started">
-	<topic href="help/02_Getting_started/getting_started.html" label="Getting started">
-		<topic href="help/02_Getting_started/getting_started.html#Installation" label="Installation"></topic>
-		<topic href="help/02_Getting_started/getting_started.html#Introduction" label="Introduction"></topic>
-		<topic href="help/02_Getting_started/getting_started.html#CallHandlingexampleexplained" label="CallHandling example explained"></topic>
-		<topic href="help/02_Getting_started/getting_started.html#Prepareaproject" label="Prepare a project"></topic>
-		<topic href="help/02_Getting_started/getting_started.html#Createastatechartmodel" label="Create a statechart model"></topic>
-		<topic href="help/02_Getting_started/getting_started.html#UsetheEditor" label="Use the Editor"></topic>
-		<topic href="help/02_Getting_started/getting_started.html#Simulatingthemodel" label="Simulating the model"></topic>
-		<topic href="help/02_Getting_started/getting_started.html#GenerateJavacode" label="Generate Java code"></topic>
-		<topic href="help/02_Getting_started/getting_started.html#Integrationwithclientcode" label="Integration with client code"></topic>
-		<topic href="help/02_Getting_started/getting_started.html#Weblinks" label="Weblinks"></topic>
+<toc topic="help/user/02_Getting_Started/getting_started.html" label="getting_started">
+	<topic href="help/user/02_Getting_Started/getting_started.html" label="Getting started">
+		<topic href="help/user/02_Getting_Started/getting_started.html#Installation" label="Installation"></topic>
+		<topic href="help/user/02_Getting_Started/getting_started.html#Introduction" label="Introduction"></topic>
+		<topic href="help/user/02_Getting_Started/getting_started.html#CallHandlingexampleexplained" label="CallHandling example explained"></topic>
+		<topic href="help/user/02_Getting_Started/getting_started.html#Prepareaproject" label="Prepare a project"></topic>
+		<topic href="help/user/02_Getting_Started/getting_started.html#Createastatechartmodel" label="Create a statechart model"></topic>
+		<topic href="help/user/02_Getting_Started/getting_started.html#UsetheEditor" label="Use the Editor"></topic>
+		<topic href="help/user/02_Getting_Started/getting_started.html#Simulatingthemodel" label="Simulating the model"></topic>
+		<topic href="help/user/02_Getting_Started/getting_started.html#GenerateJavacode" label="Generate Java code"></topic>
+		<topic href="help/user/02_Getting_Started/getting_started.html#Integrationwithclientcode" label="Integration with client code"></topic>
+		<topic href="help/user/02_Getting_Started/getting_started.html#Weblinks" label="Weblinks"></topic>
 	</topic>
 </toc>

文件差異過大導致無法顯示
+ 160 - 6
plugins/org.yakindu.sct.doc.user/help/02_Getting_started/getting_started.html


+ 4 - 4
plugins/org.yakindu.sct.doc.user/help/03_Tasks/tasks-toc.xml

@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding='utf-8' ?>
-<toc topic="help/03_Tasks/tasks.html" label="tasks">
-	<topic href="help/03_Tasks/tasks.html" label="Tasks">
-		<topic href="help/03_Tasks/tasks.html#SimulatingOperationsWithCustomJavaCode" label="Simulating Operations With Custom Java Code"></topic>
-		<topic href="help/03_Tasks/tasks.html#GeneratingCode" label="Generating Code"></topic>
+<toc topic="help/user/03_Tasks/tasks.html" label="tasks">
+	<topic href="help/user/03_Tasks/tasks.html" label="Tasks">
+		<topic href="help/user/03_Tasks/tasks.html#SimulatingOperationsWithCustomJavaCode" label="Simulating Operations With Custom Java Code"></topic>
+		<topic href="help/user/03_Tasks/tasks.html#GeneratingCode" label="Generating Code"></topic>
 	</topic>
 </toc>

文件差異過大導致無法顯示
+ 77 - 3
plugins/org.yakindu.sct.doc.user/help/03_Tasks/tasks.html


二進制
plugins/org.yakindu.sct.doc.user/help/04_Reference/images/TrafficLight.png


+ 75 - 66
plugins/org.yakindu.sct.doc.user/help/04_Reference/reference-toc.xml

@@ -1,81 +1,90 @@
 <?xml version='1.0' encoding='utf-8' ?>
-<toc topic="help/04_Reference/reference.html" label="reference">
-	<topic href="help/04_Reference/reference.html" label="SCT Reference">
-		<topic href="help/04_Reference/reference.html#Statechartelements" label="Statechart elements">
-			<topic href="help/04_Reference/reference.html#Regions" label="Regions"></topic>
-			<topic href="help/04_Reference/reference.html#States" label="States"></topic>
-			<topic href="help/04_Reference/reference.html#Transitions" label="Transitions"></topic>
-			<topic href="help/04_Reference/reference.html#Initialstateandfinalstate" label="Initial state and final state"></topic>
-			<topic href="help/04_Reference/reference.html#Choice" label="Choice"></topic>
-			<topic href="help/04_Reference/reference.html#Junction" label="Junction"></topic>
-			<topic href="help/04_Reference/reference.html#CompositeState" label="Composite State">
-				<topic href="help/04_Reference/reference.html#Orthogonalstates" label="Orthogonal states"></topic>
-				<topic href="help/04_Reference/reference.html#Submachinestates" label="Submachine states"></topic>
+<toc topic="help/user/04_Reference/reference.html" label="reference">
+	<topic href="help/user/04_Reference/reference.html" label="SCT Reference">
+		<topic href="help/user/04_Reference/reference.html#Statechartelements" label="Statechart elements">
+			<topic href="help/user/04_Reference/reference.html#Regions" label="Regions"></topic>
+			<topic href="help/user/04_Reference/reference.html#States" label="States"></topic>
+			<topic href="help/user/04_Reference/reference.html#Transitions" label="Transitions"></topic>
+			<topic href="help/user/04_Reference/reference.html#Initialstateandfinalstate" label="Initial state and final state"></topic>
+			<topic href="help/user/04_Reference/reference.html#Choice" label="Choice"></topic>
+			<topic href="help/user/04_Reference/reference.html#Junction" label="Junction"></topic>
+			<topic href="help/user/04_Reference/reference.html#CompositeState" label="Composite State">
+				<topic href="help/user/04_Reference/reference.html#Orthogonalstates" label="Orthogonal states"></topic>
+				<topic href="help/user/04_Reference/reference.html#Submachinestates" label="Submachine states"></topic>
 			</topic>
-			<topic href="help/04_Reference/reference.html#ShallowHistory" label="Shallow History"></topic>
-			<topic href="help/04_Reference/reference.html#DeepHistory" label="Deep History"></topic>
+			<topic href="help/user/04_Reference/reference.html#ShallowHistory" label="Shallow History"></topic>
+			<topic href="help/user/04_Reference/reference.html#DeepHistory" label="Deep History"></topic>
 		</topic>
-		<topic href="help/04_Reference/reference.html#Statechartdescriptionlanguage" label="Statechart description language">
-			<topic href="help/04_Reference/reference.html#Typesystem" label="Typesystem"></topic>
-			<topic href="help/04_Reference/reference.html#Expressions" label="Expressions">
-				<topic href="help/04_Reference/reference.html#LogicalAND" label="Logical AND"></topic>
-				<topic href="help/04_Reference/reference.html#LogicalOR" label="Logical OR"></topic>
-				<topic href="help/04_Reference/reference.html#LogicalNOT" label="Logical NOT"></topic>
-				<topic href="help/04_Reference/reference.html#Conditionalexpression" label="Conditional expression"></topic>
-				<topic href="help/04_Reference/reference.html#BitwiseXOR" label="Bitwise XOR"></topic>
-				<topic href="help/04_Reference/reference.html#BitwiseOR" label="Bitwise OR"></topic>
-				<topic href="help/04_Reference/reference.html#BitwiseAND" label="Bitwise AND"></topic>
-				<topic href="help/04_Reference/reference.html#LogicalRelationsandShiftOperators" label="Logical Relations and Shift Operators"></topic>
-				<topic href="help/04_Reference/reference.html#Binaryarithmeticoperators" label="Binary arithmetic operators"></topic>
-				<topic href="help/04_Reference/reference.html#Unaryarithmeticoperators" label="Unary arithmetic operators"></topic>
+		<topic href="help/user/04_Reference/reference.html#Statechartdescriptionlanguage" label="Statechart description language">
+			<topic href="help/user/04_Reference/reference.html#Typesystem" label="Typesystem"></topic>
+			<topic href="help/user/04_Reference/reference.html#Expressions" label="Expressions">
+				<topic href="help/user/04_Reference/reference.html#LogicalAND" label="Logical AND"></topic>
+				<topic href="help/user/04_Reference/reference.html#LogicalOR" label="Logical OR"></topic>
+				<topic href="help/user/04_Reference/reference.html#LogicalNOT" label="Logical NOT"></topic>
+				<topic href="help/user/04_Reference/reference.html#Conditionalexpression" label="Conditional expression"></topic>
+				<topic href="help/user/04_Reference/reference.html#BitwiseXOR" label="Bitwise XOR"></topic>
+				<topic href="help/user/04_Reference/reference.html#BitwiseOR" label="Bitwise OR"></topic>
+				<topic href="help/user/04_Reference/reference.html#BitwiseAND" label="Bitwise AND"></topic>
+				<topic href="help/user/04_Reference/reference.html#LogicalRelationsandShiftOperators" label="Logical Relations and Shift Operators"></topic>
+				<topic href="help/user/04_Reference/reference.html#Binaryarithmeticoperators" label="Binary arithmetic operators"></topic>
+				<topic href="help/user/04_Reference/reference.html#Unaryarithmeticoperators" label="Unary arithmetic operators"></topic>
 			</topic>
-			<topic href="help/04_Reference/reference.html#Statements" label="Statements"></topic>
-			<topic href="help/04_Reference/reference.html#Scopes" label="Scopes">
-				<topic href="help/04_Reference/reference.html#Namespace" label="Namespace"></topic>
-				<topic href="help/04_Reference/reference.html#interfacescope" label="interface scope"></topic>
-				<topic href="help/04_Reference/reference.html#internalscope" label="internal scope"></topic>
+			<topic href="help/user/04_Reference/reference.html#Statements" label="Statements"></topic>
+			<topic href="help/user/04_Reference/reference.html#Scopes" label="Scopes">
+				<topic href="help/user/04_Reference/reference.html#Namespace" label="Namespace"></topic>
+				<topic href="help/user/04_Reference/reference.html#interfacescope" label="interface scope"></topic>
+				<topic href="help/user/04_Reference/reference.html#internalscope" label="internal scope"></topic>
 			</topic>
-			<topic href="help/04_Reference/reference.html#Declarations" label="Declarations"></topic>
-			<topic href="help/04_Reference/reference.html#Events" label="Events"></topic>
-			<topic href="help/04_Reference/reference.html#Variables" label="Variables"></topic>
-			<topic href="help/04_Reference/reference.html#ReactionTriggers" label="Reaction Triggers">
-				<topic href="help/04_Reference/reference.html#after" label="after"></topic>
-				<topic href="help/04_Reference/reference.html#every" label="every"></topic>
-				<topic href="help/04_Reference/reference.html#always" label="always"></topic>
-				<topic href="help/04_Reference/reference.html#defaultelse" label="default, else"></topic>
-				<topic href="help/04_Reference/reference.html#entry" label="entry"></topic>
-				<topic href="help/04_Reference/reference.html#exit" label="exit"></topic>
-				<topic href="help/04_Reference/reference.html#oncycle" label="oncycle"></topic>
+			<topic href="help/user/04_Reference/reference.html#Declarations" label="Declarations"></topic>
+			<topic href="help/user/04_Reference/reference.html#Events" label="Events"></topic>
+			<topic href="help/user/04_Reference/reference.html#Variables" label="Variables"></topic>
+			<topic href="help/user/04_Reference/reference.html#ReactionTriggers" label="Reaction Triggers">
+				<topic href="help/user/04_Reference/reference.html#after" label="after"></topic>
+				<topic href="help/user/04_Reference/reference.html#every" label="every"></topic>
+				<topic href="help/user/04_Reference/reference.html#always" label="always"></topic>
+				<topic href="help/user/04_Reference/reference.html#defaultelse" label="default, else"></topic>
+				<topic href="help/user/04_Reference/reference.html#entry" label="entry"></topic>
+				<topic href="help/user/04_Reference/reference.html#exit" label="exit"></topic>
+				<topic href="help/user/04_Reference/reference.html#oncycle" label="oncycle"></topic>
 			</topic>
-			<topic href="help/04_Reference/reference.html#Operations" label="Operations"></topic>
-			<topic href="help/04_Reference/reference.html#BuildInFunctions" label="Build-In Functions">
-				<topic href="help/04_Reference/reference.html#valueofevent" label="valueof(event)"></topic>
-				<topic href="help/04_Reference/reference.html#activestate" label="active(state)"></topic>
+			<topic href="help/user/04_Reference/reference.html#Operations" label="Operations"></topic>
+			<topic href="help/user/04_Reference/reference.html#BuildInFunctions" label="Build-In Functions">
+				<topic href="help/user/04_Reference/reference.html#valueofevent" label="valueof(event)"></topic>
+				<topic href="help/user/04_Reference/reference.html#activestate" label="active(state)"></topic>
 			</topic>
-			<topic href="help/04_Reference/reference.html#LocalReactions" label="LocalReactions"></topic>
-			<topic href="help/04_Reference/reference.html#EntryPoints" label="EntryPoints"></topic>
-			<topic href="help/04_Reference/reference.html#ExitPoints" label="ExitPoints"></topic>
+			<topic href="help/user/04_Reference/reference.html#LocalReactions" label="LocalReactions"></topic>
+			<topic href="help/user/04_Reference/reference.html#EntryPoints" label="EntryPoints"></topic>
+			<topic href="help/user/04_Reference/reference.html#ExitPoints" label="ExitPoints"></topic>
 		</topic>
-		<topic href="help/04_Reference/reference.html#SGenGeneratorFeatures" label="SGen Generator Features">
-			<topic href="help/04_Reference/reference.html#Outlet" label="Outlet"></topic>
-			<topic href="help/04_Reference/reference.html#LicenseHeader" label="LicenseHeader"></topic>
-			<topic href="help/04_Reference/reference.html#FunctionInlining" label="FunctionInlining"></topic>
-			<topic href="help/04_Reference/reference.html#Debug" label="Debug"></topic>
+		<topic href="help/user/04_Reference/reference.html#SGenGeneratorFeatures" label="SGen Generator Features">
+			<topic href="help/user/04_Reference/reference.html#Outlet" label="Outlet"></topic>
+			<topic href="help/user/04_Reference/reference.html#LicenseHeader" label="LicenseHeader"></topic>
+			<topic href="help/user/04_Reference/reference.html#FunctionInlining" label="FunctionInlining"></topic>
+			<topic href="help/user/04_Reference/reference.html#Debug" label="Debug"></topic>
 		</topic>
-		<topic href="help/04_Reference/reference.html#JavaGeneratorFeatures" label="Java Generator Features">
-			<topic href="help/04_Reference/reference.html#Naming" label="Naming"></topic>
-			<topic href="help/04_Reference/reference.html#GeneralFeatures" label="GeneralFeatures"></topic>
+		<topic href="help/user/04_Reference/reference.html#JavaGeneratorFeatures" label="Java Generator Features">
+			<topic href="help/user/04_Reference/reference.html#Naming" label="Naming"></topic>
+			<topic href="help/user/04_Reference/reference.html#GeneralFeatures" label="GeneralFeatures"></topic>
 		</topic>
-		<topic href="help/04_Reference/reference.html#CGeneratorFeatures" label="C Generator Features">
-			<topic href="help/04_Reference/reference.html#CCodeFeature" label="CCodeFeature"></topic>
+		<topic href="help/user/04_Reference/reference.html#CGeneratorFeatures" label="C Generator Features">
+			<topic href="help/user/04_Reference/reference.html#CCodeFeature" label="CCodeFeature"></topic>
 		</topic>
-		<topic href="help/04_Reference/reference.html#CreateCustomCodeGenerators" label="Create Custom Code Generators">
-			<topic href="help/04_Reference/reference.html#WritingacustomcodegeneratorwithXtend2Java" label="Writing a custom code generator with Xtend2/Java"></topic>
-			<topic href="help/04_Reference/reference.html#ExecutingacustomXtend2Javacodegenerator" label="Executing a custom Xtend2/Java code generator">
-				<topic href="help/04_Reference/reference.html#Generator" label="Generator"></topic>
+		<topic href="help/user/04_Reference/reference.html#CreateCustomCodeGenerators" label="Create Custom Code Generators">
+			<topic href="help/user/04_Reference/reference.html#WritingacustomcodegeneratorwithXtend2Java" label="Writing a custom code generator with Xtend2/Java"></topic>
+			<topic href="help/user/04_Reference/reference.html#ExecutingacustomXtend2Javacodegenerator" label="Executing a custom Xtend2/Java code generator">
+				<topic href="help/user/04_Reference/reference.html#Generator" label="Generator"></topic>
 			</topic>
-			<topic href="help/04_Reference/reference.html#ExecutingacustomXpandcodegenerator" label="Executing a custom Xpand code generator">
-				<topic href="help/04_Reference/reference.html#Template" label="Template"></topic>
+			<topic href="help/user/04_Reference/reference.html#ExecutingacustomXpandcodegenerator" label="Executing a custom Xpand code generator">
+				<topic href="help/user/04_Reference/reference.html#Template" label="Template"></topic>
+			</topic>
+		</topic>
+		<topic href="help/user/04_Reference/reference.html#APIspecificationsofthegeneratedcode" label="API specifications of the generated code">
+			<topic href="help/user/04_Reference/reference.html#SpecificationsofJavacode" label="Specifications of Java code">
+				<topic href="help/user/04_Reference/reference.html#InterfaceIStatemachine" label="Interface IStatemachine"></topic>
+				<topic href="help/user/04_Reference/reference.html#Timedstatemachines" label="Timed statemachines"></topic>
+				<topic href="help/user/04_Reference/reference.html#DefaultimplementationofITimerService" label="Default implementation of ITimerService"></topic>
+				<topic href="help/user/04_Reference/reference.html#Runtimeservice" label="Runtime service"></topic>
+				<topic href="help/user/04_Reference/reference.html#Integrationofgeneratedcode" label="Integration of generated code"></topic>
 			</topic>
 		</topic>
 	</topic>

文件差異過大導致無法顯示
+ 1195 - 37
plugins/org.yakindu.sct.doc.user/help/04_Reference/reference.html


文件差異過大導致無法顯示
+ 1005 - 685
plugins/org.yakindu.sct.doc.user/help/04_Reference/reference.textile


+ 4 - 4
plugins/org.yakindu.sct.generator.java/src/org/yakindu/sct/generator/java/RuntimeService.xtend

@@ -191,11 +191,11 @@ class RuntimeService {
 			}
 
 			/**
-			 * Pauses the execution of all statemachine which are registered for the
+			 * Pauses the execution of all statemachines which are registered for the
 			 * given cyclePeriod.
 			 * 
 			 * @param cyclePeriod
-			 * @return {@code true} if poperly paused
+			 * @return {@code true} if properly paused
 			 * 
 			 */
 			public boolean pauseAll(long cyclePeriod) {
@@ -207,11 +207,11 @@ class RuntimeService {
 			}
 
 			/**
-			 * Resumes the execution of all statemachine which are registered for the
+			 * Resumes the execution of all statemachines which are registered for the
 			 * given cyclePeriod.
 			 * 
 			 * @param cyclePeriod
-			 * @return {@code true} if poperly resumed
+			 * @return {@code true} if properly resumed
 			 * 
 			 */
 			public boolean resumeAll(long cyclePeriod) {