joergreichert / spray

Automatically exported from code.google.com/p/spray
1 stars 2 forks source link

[style] Remove description attribute, use multi-line comment instead #110

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
I think it would be better to describe a style simply by a standard multiline 
comment.

style BlackAndWhiteStyle {
  description = "A style with white background and black foreground."
  ...
}

/** "A style with white background and black foreground. */
style BlackAndWhiteStyle {
  ...
}

I guess the reason why it is an attribute is to use the description in the 
generator and validation. Actually this can be achieved also by injecting the 
IEObjectDocumentationProvider.

Original issue reported on code.google.com by karsten....@googlemail.com on 24 Mar 2012 at 12:30

GoogleCodeExporter commented 9 years ago
If this is used bu the generator and provides e.g. help messages,  I consider 
this semantically part of the model and in that case I think the description 
field is quite ok.
That way comments are for the DSL developer to explain the model and the 
description attribute is for the end-users.  Different things for different 
purposes.

Original comment by joswar...@gmail.com on 3 Nov 2012 at 6:34

GoogleCodeExporter commented 9 years ago
This is not an issue,  but works as it should.

Original comment by joswar...@gmail.com on 19 Nov 2012 at 2:02