Re: RFR: JDK-8075778: Add javadoc tag to avoid duplication of return information in simple situations.

2020-12-03 Thread Jonathan Gibbons
On Thu, 3 Dec 2020 21:19:38 GMT, Joe Darcy wrote: >> There is lots of other duplication/repetition in most javadoc. I'd rather >> see some kind of text macro that would allow a single definition of a string >> that can be repeated. The source would be a bit less readable, but it would >> be l

Re: RFR: JDK-8075778: Add javadoc tag to avoid duplication of return information in simple situations.

2020-12-03 Thread Joe Darcy
On Fri, 27 Nov 2020 16:33:27 GMT, Roger Riggs wrote: > > > ``` > /** > * {@return the result} Optional additional text. > */ > ``` > > The java source looks a bit odd/unusual because the "first sentence" does not > appear to end with a period. > Though it seems like a convenience to inclu

Re: RFR: JDK-8075778: Add javadoc tag to avoid duplication of return information in simple situations.

2020-12-03 Thread Joe Darcy
On Wed, 2 Dec 2020 15:39:56 GMT, Roger Riggs wrote: > > > There is lots of other duplication/repetition in most javadoc. I'd rather see > some kind of text macro that would allow a single definition of a string that > can be repeated. The source would be a bit less readable, but it would be

Re: RFR: JDK-8075778: Add javadoc tag to avoid duplication of return information in simple situations. [v5]

2020-12-03 Thread Jonathan Gibbons
> This change extends the functionality of the `@return` tag so that it can > also be used as an inline tag in the first sentence of a description. > > The goal is to be able to simplify the following common pattern: > > /** > * Returns the result. Optional additional text. > * @re