google / google/styleguide

Eclipse format changes single-line javadocs

Open
#725 0 comments 0 reactions 0 assignees View on GitHub
lang:java
Dominant language
HTML
Stars
39.6k
Forks
12.9k
Avg merge
42m
Merged PRs (30d)
15

Description

The [eclipse-java-google-style.xml](https://github.com/google/styleguide/blob/gh-pages/eclipse-java-google-style.xml) specifies that javadoc should always be the "basic" format:

```
The basic formatting of Javadoc blocks is as seen in this example:

/**
* Multiple lines of Javadoc text are written here,
* wrapped normally...
*/
public int method(String p1) { ... }
```
but that single-line javadocs are allowed when it fits on one line.

Other tools (like that google formatter in spotless maven plugin) reflows this to a single line when possible.

The solution is to change one settings in the eclipse format profile to be:

```

```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.