Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 366905

Summary:	generator for documentation
Product:	[Modeling] eTrice	Reporter:	Thomas Schuetz <ts>
Component:	Generators	Assignee:	Thomas Jung <tj>
Status:	RESOLVED FIXED	QA Contact:
Severity:	enhancement
Priority:	P3	CC:	hrr
Version:	0.1.0
Target Milestone:	0.4.0
Hardware:	PC
OS:	Windows 7
Whiteboard:	consolidation

Description Thomas Schuetz

2011-12-15 18:07:50 EST

org.eclipse.etrice.generator.doc

a generator for documentation should contain at least:
- html or docbook document providing a structured doc for all classes and their diagrams (Actor and FSM Diagrams)
- actor instance tree (model -> graphviz -> jpeg)
- inheritance tree

the doc generator should be independent of language specific generators like org.eclipse.etrice.generator.java

if language specific documentation is needed, the language specific generators should take care of that

Comment 1 Henrik Rentz-Reichert

2012-02-27 13:29:45 EST

Thomas J.,

please report about the progress of the documentation generation.

Thanks,
Henrik

Comment 2 Thomas Jung

2012-03-02 02:56:18 EST

The status is as follows:
- The doc generator takes all documentation parts from the model and generates a latex file.
- Table of contens, table of figure is generated. 
- The structure of the document is as follows:
1. Model doc
2. Instancetree (not implementet jet)
3. Actor classes
3.1 Attributes with documentation in a table
3.2 Structure with the appropriate image and model documentation
3.3 Behavior
3.3.1 Operqations with return value and parameter list with model docu in a table
3.3.2 Statemachine. Image and modeldocu

To do:
- Instance tree
- scaling of images
- access the subgraphs of the FSM
- testing

To generate the docu you must check the "instance tree" check box in the launch config. Beside the instance tree an .tx file is generated. If MIKTEX is installed you just need to double click the .tx file and press run to generate the PDF.

Comment 3 Henrik Rentz-Reichert

2013-08-14 12:56:01 EDT

Closing this bug with
4089fc688a5121fd7ab1467451afef44e8c4310b

But there is still room for improvements ;-)