Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 110691 - Description text for JUnit test methods is not used as JavaDoc comment text in generated Java method.
Summary: Description text for JUnit test methods is not used as JavaDoc comment text i...
Status: CLOSED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: TPTP (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Julien Canches CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 134254
Blocks: 90628
  Show dependency tree
 
Reported: 2005-09-26 15:09 EDT by Paul Slauenwhite CLA
Modified: 2016-05-05 11:06 EDT (History)
0 users

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Paul Slauenwhite CLA 2005-09-26 15:09:57 EDT 
Description text for JUnit test methods is not used as JavaDoc comment text in 
generated Java method.

The test method description text should be used as the JavaDoc comment text in 
generated Java method since it describes the test method.

Using the TPTP_v4_1_0_200509260100 driver, create a TPTP JUnit test, create a 
test method and add some description text.  Add an invocation to the test 
method as a behavior and open the generate Java test suite class.  Note that 
the JavaDoc comment does not contain the test method's description text.
Comment 1 Paul Slauenwhite CLA 2006-03-13 11:54:57 EST 
Is this defect still intended for TPTP V4.2.0?
Comment 2 Julien Canches CLA 2006-03-13 12:04:11 EST 
(In reply to comment #1)
My intent is still to fix it for i2.
Comment 3 Julien Canches CLA 2006-03-31 08:33:32 EST 
After investigation, the fix for this bug cannot be contained in i2, and the changes it implies require architectural changes (see bugzilla 134254).

To be accurate, the method description is used in the javadoc for the generated Java method, only if this method is first created in the model. However, the javadoc comment is not updated if the method description is changed after the java method has been generated. The (ugly) work-around is to delete the method from the code, then save the model again.
Updating the javadoc would require to use another JDT tooling (AST rather than the JDT model).

Retargetting to the next release (because of the dependency on the architectural change).
Comment 4 Julien Canches CLA 2006-08-10 12:33:06 EDT 
Fixed
Description in the model is reflected to the java source when the test suite is saved.
And model description is updated if the user modifies the javadoc.
Comment 5 Paul Slauenwhite CLA 2006-11-16 09:00:50 EST 
ACTION: Please verify/close this defect.
Comment 6 Julien Canches CLA 2006-11-16 09:51:11 EST 
Verified on TPTP-4.3.0-200611070100 driver.