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

Bug 338796

Summary:	Documentation as Modelelement
Product:	[Modeling] eTrice	Reporter:	Thomas Jung <tj>
Component:	Core	Assignee:	Henrik Rentz-Reichert <hrr>
Status:	CLOSED FIXED	QA Contact:
Severity:	enhancement
Priority:	P3	CC:	ts
Version:	unspecified
Target Milestone:	---
Hardware:	PC
OS:	Windows 7
Whiteboard:	0.1.0

Description Thomas Jung

2011-03-03 07:43:59 EST

It should be possible to add documentation to the concrete model. This is very helpfull to create generators to generate documentation out of a concrete model.

Comment 1 Henrik Rentz-Reichert

2011-03-04 08:25:41 EST

This is definitely something we should add!

I would propose to use a notation like
doc "some description"
	"can run over several lines"
	
We should decide about the points where such Documentation elements can be attached to.
I will start a list here
- RoomClass
- Attribute
- Operation
- Message
- Port
- State

Comment 2 Thomas Jung

2011-03-04 12:33:02 EST

some additional list elements
- RoomClass
- Attribute
- Operation
- Message
- Port
- State

- Choicepoint
- Protocoll
- FSM/Structure Diagram
- Package ?
- Actor Reference
- Transition

Comment 3 Henrik Rentz-Reichert

2011-03-04 12:44:03 EST

(In reply to comment #2)
> - Protocoll
a ProtocolClass is a RoomClass
> - FSM/Structure Diagram
there is no FSM/Structure object, so we add two special docs to the ActorClass
> - Package ?
this corresponds to the RoomModel

so we have

- RoomClass
- Attribute
- Operation
- Message
- Port
- State
- Choicepoint
- StructureClass, structureDoc
- ActorClass, stateMachinDoc
- RoomModel
- ActorRef
- SubSystemRef
- Transition

Another possible notation for documentation could be
[ "some description"
  "can run over several lines" ]

And where should we add the doc in the grammar, right after the name attribute?

Comment 4 Thomas Jung

2011-03-04 13:03:54 EST

This looks good

	LogicalSystem System_PingPong 
	["some documentation that can"
	"run"
	"over several lines"]
	{
		SubSystemRef subsystem : SubSystem_PingPong
	}

(In reply to comment #3)
> (In reply to comment #2)
> > - Protocoll
> a ProtocolClass is a RoomClass
> > - FSM/Structure Diagram
> there is no FSM/Structure object, so we add two special docs to the ActorClass
> > - Package ?
> this corresponds to the RoomModel
> so we have
> - RoomClass
> - Attribute
> - Operation
> - Message
> - Port
> - State
> - Choicepoint
> - StructureClass, structureDoc
> - ActorClass, stateMachinDoc
> - RoomModel
> - ActorRef
> - SubSystemRef
> - Transition
> Another possible notation for documentation could be
> [ "some description"
>   "can run over several lines" ]
> And where should we add the doc in the grammar, right after the name attribute?

Comment 5 Thomas Schuetz

2011-03-06 12:54:35 EST

Notation and scope is ok for me.
We have to see how his feels in real models.
Maybe the non formal content of elements like documentation should be at the end of an element. But we should go with the current proposal for now.

Comment 6 Henrik Rentz-Reichert

2011-03-09 06:24:29 EST

added documentation as  discussed in comment 2 and comment 3.

Committed with fb6a5ede22c0ef8fcdac7296c984db5d38a01781

Comment 7 Henrik Rentz-Reichert

2011-12-16 02:45:53 EST

closed resolved bug

Comment 8 Henrik Rentz-Reichert

2011-12-16 02:48:13 EST

tagged as version 0.1.0