Bug 17373 - create getter/setter - getter javadoc text [code manipulation]
Summary: create getter/setter - getter javadoc text [code manipulation]
Status: RESOLVED WONTFIX
Alias: None
Product: JDT
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 2.0   Edit
Hardware: PC All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: JDT-UI-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: investigate
Depends on:
Blocks:
 
Reported: 2002-05-23 11:47 EDT by Claude Knaus CLA
Modified: 2003-01-20 11:44 EST (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Claude Knaus CLA 2002-05-23 11:47:44 EDT
The getter javadoc says:

/**
 * Gets the name.
 * @return Returns a string
 */

It should be:

/**
 * Returns the name.
 * @return returns the name
 */

I'm not sure about the second line, but I feel strongly about the first line.
Also, I think the param lines should start with lower case letters.
Comment 1 Erich Gamma CLA 2002-05-25 09:18:13 EDT
These comments have no value and we should not generate them in this form.
We either generate no comment or change the comment to:


	/**
	 * 
	 * @return int
	 */
Comment 2 Martin Aeschlimann CLA 2002-05-27 14:31:23 EDT
fixed > f1
Comment 3 Erich Gamma CLA 2002-06-02 16:49:32 EDT
changed milestone from F1 to F2
Comment 4 Erich Gamma CLA 2002-06-02 17:33:07 EDT
pls verify
Comment 5 Dani Megert CLA 2002-06-03 05:38:40 EDT
Need to clear resolution due to bugzilla bug (it changed the resolution to NEW)
Comment 6 Dani Megert CLA 2002-06-03 05:41:39 EDT
Marking bug as fixed again (due to bugzilla bug)
Comment 7 Dani Megert CLA 2002-06-03 08:12:23 EDT
Not fixed. Both Javdoc comments are not good if follwoing the Javadoc guidelines
("How to Write Doc comments fo Javadoc").

	/**
	 * Sets the f.
	 * @param f The f to set
	 */

1) phrases (which are prefered to sentences) are not capitalized and don't end
with a dot.
2) after the tag follows the parameter name. After that the first noun should be
the data type (starting with lower letter). SPECIAL RULE: for the primitive type
int the data type is omitted.

See "How to Write Doc comments fo Javadoc" for detailed guidelines on how
Javadoc should be written.
Comment 8 Erich Gamma CLA 2002-06-08 19:09:29 EDT
defer
Comment 9 Dirk Baeumer CLA 2003-01-20 11:44:24 EST
This will be user configurable for 2.1. 

Closing