#593 Allow annotations on algebraic variables

• Best to review per commit.
• Some additional changes for the CIF code generator:
  • C89/C99/Simulink code generation: algebraic variable JavaDocs now end with ., not ;.
  • C89/C99/Simulink code generation: algebraic variable JavaDocs had a newline too many.
  • C89/C99 code generation: algebraic variable JavaDocs are now on a single line if the algebraic variable has no documentation annotations.

Addresses #593 (closed)

changed milestone to %v3.0

added CIF TypeEnhancement labels

Not sure a . at the end of an expression is a good idea. The ; feels cleaner because that symbol is definitely not part of the expression. On the other hand, maybe the problem is that the line tries to be text as well as expression, and that are conflicting goals I think.

So not sure what is the right solution here. Seems ok otherwise.

Yes, I saw that as well. I thought it was a mistake, but maybe it was intended after all then. The . gives consistency, and does feel better to me.

But, I don't like the JavaDoc in general, as varname = autname = locname kind of stuff is not very readable either, with all the = signs. I'm not sure the definition/value of the algebraic variable should be included at all. We don't include it for Java code, but we do for C. And so on. I'm not aware of anyone using the C code generation, so I'm not sure it is worth spending a lot of time on it.

Since you also don't know, I'll leave it as is.

Fine by me.

approved this merge request

merged

mentioned in commit d856912e

mentioned in issue #593 (closed)