Bug 497599

Description Liam Miller-Cushon 2016-07-09 01:36:14 EDT

Created attachment 262997 [details]
A CodeFormatter plugin that demonstrates the issue

The CodeFormatter extension point doesn't support making non-whitespace changes to javadoc when formatting snippets.

For example, when the `Generate Constructor using Fields...` refactoring is run with generated javadoc enabled, it formats a snippet like:

```
/**
 */public Hello(int x){super();this.x=x;}
```

And then rewrites the leading "/**\n */" to include the appropriate `@param` tags as a second step.

If a custom CodeFormatter changes the leading "/**\n */", e.g. to:

```
/**
 *
 */
```

Then the location of the leading comment is lost, and the generated javadoc defaults to being inserted at the end of the snippet.

Is this a bug? I expected the snippet formatting logic to tolerate non-whitespace changes inside javadoc.

Demo:

The attached zip file contains a CodeFormatter implementation that does nothing but rewrite leading "/**\n */" comments.

* extract codeformatterdemo.zip and open the project
* run it as an Eclipse Application
* create a Java project, and add a simple class:

```
public class Hello {
int x;
}
```

* enable the custom formatter: Java > Code Style > Formatter > Formatter implementation > Demo Java Formatter
* select the class name and run: Source > Generate Constructor using Fields...
* check `Generate constructor comments`

```
public class Hello {
/**
 *
 */public Hello(int x){super();this.x=x;}/**
 * @param x
 */

int x;
}
```