Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuergen Haug2019-05-16 08:41:28 -0400
committerJuergen Haug2019-05-16 08:41:28 -0400
commit8ec8992bb0b274ab02ed374ccab55494cd2087e5 (patch)
tree20036699418c05b6f85f533a9d27f21e34116856
parent495cb87aa42c5ed8a9452c81eb6bf281870fad68 (diff)
downloadorg.eclipse.etrice-8ec8992bb0b274ab02ed374ccab55494cd2087e5.tar.gz
org.eclipse.etrice-8ec8992bb0b274ab02ed374ccab55494cd2087e5.tar.xz
org.eclipse.etrice-8ec8992bb0b274ab02ed374ccab55494cd2087e5.zip
[gen.doc] genAsLibrary only generate doc for interface ports
-rw-r--r--plugins/org.eclipse.etrice.generator.doc/src/org/eclipse/etrice/generator/doc/gen/AsciiDocGen.xtend76
1 files changed, 51 insertions, 25 deletions
diff --git a/plugins/org.eclipse.etrice.generator.doc/src/org/eclipse/etrice/generator/doc/gen/AsciiDocGen.xtend b/plugins/org.eclipse.etrice.generator.doc/src/org/eclipse/etrice/generator/doc/gen/AsciiDocGen.xtend
index 9ac832d3a..62e864963 100644
--- a/plugins/org.eclipse.etrice.generator.doc/src/org/eclipse/etrice/generator/doc/gen/AsciiDocGen.xtend
+++ b/plugins/org.eclipse.etrice.generator.doc/src/org/eclipse/etrice/generator/doc/gen/AsciiDocGen.xtend
@@ -41,12 +41,15 @@ import org.eclipse.etrice.generator.fsm.base.CodegenHelpers
import org.eclipse.xtext.documentation.IEObjectDocumentationProvider
import static org.eclipse.etrice.core.common.documentation.DocumentationMarkup.*
+import org.eclipse.etrice.generator.doc.Main
+import org.eclipse.etrice.generator.base.AbstractGeneratorOptionsHelper
@Singleton
class AsciiDocGen {
@Inject extension RoomHelpers
@Inject extension CodegenHelpers
+ @Inject protected extension AbstractGeneratorOptionsHelper
@Inject IEObjectDocumentationProvider eObjDocuProvider
def doGenerate(Root root, IGeneratorFileIO fileIO, boolean includeImages) {
@@ -262,7 +265,7 @@ class AsciiDocGen {
| «ims.name»
| «IF ims.data !== null»«ims.data.refType.type.name»«ELSE»void«ENDIF»
- | «ims.docText»
+ a| «ims.docText»
«ENDFOR»
|===
@@ -276,7 +279,7 @@ class AsciiDocGen {
| «oms.name»
| «IF oms.data !== null»«oms.data.refType.type.name»«ELSE»void«ENDIF»
- | «oms.docText»
+ a| «oms.docText»
«ENDFOR»
|===
@@ -323,33 +326,41 @@ class AsciiDocGen {
«ac.docText»
[discrete]
- ==== Structure
- «IF includeImages»
-
- «includeImage(ac.name + "_structure.jpg")»
- «ENDIF»
- «IF !ac.allPorts.empty»
-
- «generatePortDoc(ac)»
- «ENDIF»
- «IF !ac.attributes.empty»
-
- «ac.attributes.generateAttributesDoc»
- «ENDIF»
- «IF ac.hasNonEmptyStateMachine || !ac.operations.empty || ac.isBehaviorAnnotationPresent("BehaviorManual")»
-
- [discrete]
- ==== Behavior
- «IF !ac.operations.empty»
+ «IF Main::settings.generateAsLibrary»
+ ==== Interface
+ «IF !ac.allInterfacePorts.empty»
+
+ «generatePortInterfaceDoc(ac)»
+ «ENDIF»
+ «ELSE»
+ ==== Structure
+ «IF includeImages»
+
+ «includeImage(ac.name + "_structure.jpg")»
+ «ENDIF»
+ «IF !ac.allPorts.empty»
- «ac.operations.generateOperationsDoc»
+ «generatePortDoc(ac)»
«ENDIF»
- «IF ac.isBehaviorAnnotationPresent("BehaviorManual")»
+ «IF !ac.attributes.empty»
- The behavior for ActorClass «ac.name» is implemented manually.
- «ELSEIF ac.hasNonEmptyStateMachine»
+ «ac.attributes.generateAttributesDoc»
+ «ENDIF»
+ «IF ac.hasNonEmptyStateMachine || !ac.operations.empty || ac.isBehaviorAnnotationPresent("BehaviorManual")»
- «generateFsmDoc(ac, includeImages)»
+ [discrete]
+ ==== Behavior
+ «IF !ac.operations.empty»
+
+ «ac.operations.generateOperationsDoc»
+ «ENDIF»
+ «IF ac.isBehaviorAnnotationPresent("BehaviorManual")»
+
+ The behavior for ActorClass «ac.name» is implemented manually.
+ «ELSEIF ac.hasNonEmptyStateMachine»
+
+ «generateFsmDoc(ac, includeImages)»
+ «ENDIF»
«ENDIF»
«ENDIF»
«tagEnd(ac)»
@@ -377,6 +388,21 @@ class AsciiDocGen {
'''
}
+ def private String generatePortInterfaceDoc(ActorClass ac) '''
+ .Ports
+ |===
+ | Name | Protocol | Type | Multiplicity | Description
+ «FOR at : ac.allInterfacePorts»
+
+ | «at.name»
+ | «at.protocol.name»
+ | «at.type»
+ | «at.multAsText»
+ a| «at.docText»
+ «ENDFOR»
+ |===
+ '''
+
def private String generatePortDoc(ActorClass ac) '''
.Ports
|===

Back to the top