Activity 6: Documentation Generation for the Philips version
To obtain documentation for the Philips version of the tooling, first obtain the template as follows.
-
Right-click on VendingMachine.prj and select "Import Philips Template"; this adds a file Template.docx.
Next extend VendingMachine.prj with the following task for document generation:
Generate Documentations {
documentationTask for interface IService {
template = "Template.docx"
DHF = 123456
author = "John Smith"
- role = "R&D: SW Designer"
}
}
Execute the CommaSuite workflow and next navigate to folder src-gen/doc/ and open the generated .docx file. It contains information from the comments in the .signature and .interface files. In addition, the simple state machine is presented in a table form.