Problem - Javadoc tags in C++

[wink]

Hello everybody,

I just wonder if anybody has had this problem?

I need to document return values of class methods and would like to use the standard javadoc tag @return in the method documentation

I looked everywhere but I can not find a place where I can type it. So I tried to write it in the same place as the arguments and reverse engeneer it, but AE treats it like standard comment text.

example:

Code: [Select]

/**
* This is a class method that takes 2 arguments
* It returns an int.
*
* @param p_SomeBool    this is a boolean argument
* @param p_SomeLong    This is a long integer argument
* @return TheReturn
*/
int CSomeClass::DoSomething(bool p_SomeBool, long p_SomeLong){


return 0;
}

Any ideas?

Many thanks in advance,

cheers,
Manfred

[wink]

Bump!

Really nobody to give me a hint?


cheers,
Manfred

[mikewhit]

Try reporting it as a bug - missing functionality ...?

[wink]

Hi Mike,
well I guess you're right...

I'll try that, but I hoped that there was somebody with a work-around...

have a nice day,

Manfred

[Eve]

Hi Manfred,

Because there is no place to document it, EA maintains the @return tag inside the method note.  This is deliberate.

Is there a reason why it isn't appropriate?

[wink]

Hi Simon,

well it is just not coherent with the other tags such as the @param tags for method arguments who are generated automatically.

I thought it would be more logical to document the return value just as any argument. This way you'd be independent from what kind of ducumentation you use.

I'd like to see for instance an aditional field in the "return type advanced" dialog where you could document the meaning and possible values for the return type.

Do you think that this would be possible?

have a nice day,
cheers,
Manfred

[mikewhit]

Sounds logical to me ...

[wink]

Hi Mike,

Thanks for your support!


good day, ladies & gentlemen!

Manfred

[sl@sh]

Sorry for digging this up, but aparently nothing has changed within the past 18 months.  

I, too, would greatly appreciate added support to documenting return values.

The suggestion to add that part of the documentation to the notes section isn't really all that helpful: It requires EA modelers to keep track of methods and manually insert the '@return' bit. If at a later point document style gets changed, all the method notes need to be updated!

Or has this been added in version 7.0? Haven't had the time to check out the beta yet...

P.S.: I have searched the forum (which is how I found this thread), and the best I could find was the suggestion made in this (and also in another) thread: adding the @return tag explicitely in the notes section. IMO this is a bad solution, as pointed out above.

[Eve]

No, there hasn't been any change to this area.