Skip to content

Commit 044a873

Browse files
author
watney
committed
Update documentation
1 parent 3a37e4f commit 044a873

6 files changed

Lines changed: 9 additions & 4 deletions

File tree

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ State machine models may be specified using any of these modeling tools: +
1010
The Autocoder processes the model into any one of the following: +
1111
1) C state machine code +
1212
2) C++ state machine code +
13-
3) F` component state machine code +
13+
3) F` component state machine code and F` FPP +
1414
4) Quantum Framework state machine code +
1515

1616
## Interface and Design

STARSDesign.drawio

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

STARSDesign.png

-5.21 KB
Loading

STARSDocs.drawio

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

STARSDocs.png

50 Bytes
Loading

autocoder/Stars.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,13 +119,18 @@ def getQmRoot(modelFileName: str) -> Tuple[ElementTreeType, XmiModel] :
119119

120120
if suff == 'qm':
121121
qmRoot = etree.parse(modelFileName)
122+
# Translate QM to XMI
122123
xmiModel = QmParser.getXmiModel(qmRoot)
123124
elif suff == 'xml':
125+
# Translate Cameo to XMI
124126
cameoRoot: ElementTreeType = etree.parse(modelFileName)
125127
xmiModel = CameoParser.getXmiModel(cameoRoot)
128+
# Translate XMI to QM
126129
qmRoot = xmiToQm.translateXmiModelToQmFile(xmiModel, args.debug)
127130
elif suff == 'plantuml':
131+
# Translate UML to XMI
128132
xmiModel = UmlParser.getXmiModel(modelFileName)
133+
# Translate XMI to QM
129134
qmRoot = xmiToQm.translateXmiModelToQmFile(xmiModel, args.debug)
130135
else:
131136
print("Unknown suffix {0} on file {1}".format(suff, modelFileName))
@@ -156,7 +161,7 @@ def getQmRoot(modelFileName: str) -> Tuple[ElementTreeType, XmiModel] :
156161

157162
qmRoot, xmiModel = getQmRoot(args.model)
158163

159-
# Perform state-machine semantics checking
164+
# Check Correctness of the QM
160165
checkFaults.checkStateMachine(qmRoot)
161166

162167
if args.backend == "c++":

0 commit comments

Comments
 (0)