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

Bug 398876

Summary:	add documentation to Xtext generated meta models
Product:	[Modeling] eTrice	Reporter:	Henrik Rentz-Reichert <hrr>
Component:	Core	Assignee:	Juergen Haug <juergen.haug>
Status:	RESOLVED FIXED	QA Contact:
Severity:	enhancement
Priority:	P3	CC:	juergen.haug
Version:	0.2.0	Keywords:	helpwanted
Target Milestone:	0.3.0
Hardware:	PC
OS:	Windows XP
Whiteboard:	0.3.0 consolidation

Description Henrik Rentz-Reichert

2013-01-23 07:59:45 EST

The Xtext generated meta models (ROOM, config, etphys, etmap) lack documentation.
This documentation could be added using EAnnotations, see
http://www.eclipsezone.com/eclipse/forums/t57111.html
(also EcoreUtil.setDocumentation())

Since the ecore file is generated by the Xtext framework it shouldn't be changed directly. Rather one should use the post processing step. See the RoomPostprocessor.ext as an example.

Xtend1 is rather cumbersome though.
To use the much more convenient Xtend2 follow
http://christiandietrich.wordpress.com/2011/07/22/customizing-xtext-metamodel-inference-using-xtend2/
and delegate from the *Postprocessor.ext to an xtend class as indicated in Meinte's comment.

Comment 1 Henrik Rentz-Reichert

2013-03-04 02:46:14 EST

replaced ep in whiteboard with helpwanted keyword

Comment 2 Henrik Rentz-Reichert

2013-03-22 06:23:52 EDT

Documentation of ROOM model complete.

Comment 3 Henrik Rentz-Reichert

2013-03-22 06:29:58 EDT

Completed documentation in core.genmodel

Comment 4 Henrik Rentz-Reichert

2013-03-22 06:45:08 EDT

Added documentation to etmap.

Comment 5 Henrik Rentz-Reichert

2013-03-22 07:12:13 EDT

This was done with commits
172d10d7c09a98f121c2edc466858606131ad420
609c57fca51f03df3c9d57811d2bda605efe0fac
fb013f3fa54370f5c66ece277fa2e1702c47bbb9
d7437235dcd963311e5ec3b4a24f00f0ddf5c29a

Comment 6 Henrik Rentz-Reichert

2013-03-22 07:12:54 EDT

Jürgen, please add documentation for core.config.

Comment 7 Henrik Rentz-Reichert

2013-04-15 05:20:25 EDT

config documentation was added with
40dfb78555b1e3dd37b5323d4bf34e89561032c8

Comment 8 Henrik Rentz-Reichert

2013-04-18 02:29:00 EDT

added consolidation to whiteboard to allow association with project plan