Book a Demo

Author Topic: Return values and Javadoc  (Read 4030 times)

BruceNT

  • EA Novice
  • *
  • Posts: 1
  • Karma: +0/-0
    • View Profile
Return values and Javadoc
« on: December 24, 2003, 09:49:13 am »
The @return tag for javadoc doesn't seem to be supported (trial version of 3.60.656).  Is there a way to add a note or comment about the return value of an operation?

Bruce

stigv

  • EA Novice
  • *
  • Posts: 2
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: Return values and Javadoc
« Reply #1 on: July 19, 2006, 01:04:01 pm »
I just gave the 6.1.792 trial a spin... and 3 years later... @return is still not supported   :'(  Atleast it didn't show up in the javadoc included in source code engineering generated code. So, full javadoc seems not likely to ever! be implemented, right?

Stig

/www.designpatterns.dk

Eve

  • EA Administrator
  • EA Guru
  • *****
  • Posts: 8110
  • Karma: +119/-20
    • View Profile
Re: Return values and Javadoc
« Reply #2 on: July 19, 2006, 03:07:55 pm »
Currently EA reverse engineering includes the @return tag in the notes and as a result generates it back out again through there.

stigv

  • EA Novice
  • *
  • Posts: 2
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: Return values and Javadoc
« Reply #3 on: July 20, 2006, 12:25:17 am »
Yes, and that's great...! But... Since it is a note-added thing, you always need to _manually_ keep change up-to-date - which is a shame since fx. the @param tags are automaticly managed. Also, the @return tag doesn't get neatly formatted in the block with fx. the auto-generated @param tags. So either you add all @returns manually to the code after it has been generated - or you probably need to go in and format the javadoc tags...

Don't get me wrong - the product looks nice in other respects. Generating code properly is generally a tough thing for products to support.

Stig

/www.designpatterns.dk