Use inline {@return ...} tag for Javadoc summaries missing from the public API

[philliplbryant]

A number of public/protected members in core/ have Javadoc comments that are missing a summary but contain an @return tag. Javadoc provides the inline {@return ...} tag that can be used to satisfy both.

For JavaDocs missing a summary, but providing an @return tag, I want to replace all @return ... tags with the inline tag and move the inline tag to the summary position.

I've already made the changes and plan to open a PR.

[Col-E]

Can you post a quick example here? I'm not quite sure what you mean with inline {@return ...} as opposed to the standard @return ...

Supplying just @return AFAIK is fine if the method itself wouldn't have a useful summary.

/**
 * Get the X component.
 * @return The X component.
 */
int getX();

The summary here is not useful for instance.

---

Edit: Found an example, commented on PR