This Bugzilla instance is deprecated, and most Eclipse projects now use GitHub or Eclipse GitLab. Please see the deprecation plan for details.
Bug 400271 - JSdoc comments are formatted incorrectly
Summary: JSdoc comments are formatted incorrectly
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: VJET (show other bugs)
Version: unspecified   Edit
Hardware: Macintosh Mac OS X
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Jack Liu CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-02-07 17:59 EST by Justin Early CLA
Modified: 2017-04-11 15:12 EDT (History)
1 user (show)

See Also:

Attachments
uncheck new line after @param (208.88 KB, image/png)
2013-02-19 20:09 EST, Justin Early CLA 		no flags Details
View All 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 Justin Early CLA 2013-02-07 17:59:52 EST 
/**
	 * @param {String/Date} param
	 * @param {String} [p2]
	 * @returns {String}
	 */
	 
	 is changed to this which changes the meaning of the jsdoc and is not parsed correctly
	 
	 	/**
	 * @param {String/Date}
	 *            param
	 * @param {String}
	 *            [p2]
	 * @returns {String}
	 */
Comment 1 Justin Early CLA 2013-02-07 18:00:45 EST 
found while testing bug 399450
Comment 2 Justin Early CLA 2013-02-19 20:09:53 EST 
Created attachment 227307 [details]
uncheck new line after @param

We should make default not remove newlines
Comment 3 Jack Liu CLA 2013-02-23 06:14:28 EST 
Updated the default formatter preference.

git.exe push --progress  "origin" b_400271:b_400271

gitroot/vjet/org.eclipse.vjet.eclipse.git
Comment 4 Jack Liu CLA 2013-02-23 06:16:08 EST 
Reopen it until it was verified.
Comment 5 Justin Early CLA 2013-03-01 13:17:50 EST 
Patch looks good default settings are changed. I believe there is difference between what formatter assumes is the description vs the param name. This is a good one to not enable unless you opt in for this one.