Messages

1

Suggestions and Requests / Support Doxygen Comments

« on: December 16, 2008, 09:24:06 am »

It would be great if EA supported the Doxygen commenting style.
My requirement is for this in the C world, but I'm sure others would appreciate it for other languages.

2

Bugs and Issues / Code generation for C functions

« on: December 01, 2008, 05:07:34 pm »

I am using EA on a C project, and will be using code engineering to both forward and reverse engineer the code.

[*]When generating code for an operation with no arguments, the function prototype contains empty braces instead of explicitly stating "void":

Code: [Select]

void functionName();
[*]When importing code into the model from a function prototype with an explicit void argument such as:

Code: [Select]

void functionName(void);The model adds an argument to the operation "pm1 : void".

[*]Then generating code from this new operation the function prototype looks like:

Code: [Select]

void functionName(void pm1);[/list]
Is there a way to get EA to support (for operation parameters) equating blank in the model with "void" in the code.

3

Bugs and Issues / Re: Code generation of doxygen comments

« on: December 16, 2008, 11:58:58 am »

Thanks Simon

I've just tried out the java doc using the magic function:

Code: [Select]

%JAVADOC_COMMENT(genOptWrapComment)%Instead of:

Code: [Select]

$wrapLen = %genOptWrapComment%
%CSTYLE_COMMENT($wrapLen)%
This generates code perfectly.

However when this code is then syncronised back to the model, the javadocs end up in the notes.
Then if I do another code generation I end up with two lots of javadocs??

Any clues?

4

Bugs and Issues / Code generation of doxygen comments

« on: December 15, 2008, 05:22:37 pm »

When adding a description of a code element after the item such as

Code: [Select]

#define SOME_DEFINE 42  /**< This is a great define */
When importing the code, the comments are associated with the member, however when generating the code the standard C-template always wants to re-arrange the comment as follows:

Code: [Select]

/**
  * < This is a great define
 */
#define SOME_DEFINE 42
This may seem ok (apart from the "<" that's left over from the conversion) in this example, but imagine a 200 element enumeration definition.

Is there some smart cookie out there who could add a tagged value to indicate the required documentation for each element, then adjust the c_template to use this info to decide where to put the notes in the code?