RFR: 8235786: Javadoc for com/sun/net/httpserver/HttpExchange.java#setAttribute is unclear [v3]

Jaikiran Pai jpai at openjdk.org
Fri Nov 29 13:16:52 UTC 2024


On Fri, 29 Nov 2024 12:24:57 GMT, Michael McMahon <michaelm at openjdk.org> wrote:

>> Jaikiran Pai has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   update an existing test to verify HttpExchange.getAttribute()/setAttribute()
>
> src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpExchange.java line 236:
> 
>> 234: 
>> 235:     /**
>> 236:      * {@return the attribute's value from this exchange's
> 
> It looks a bit odd in the generated doc that this statement appears as the summary and is then repeated verbatim in the @returns. Could the first sentence be a shorter summary?
> 
> Also, since we are clarifying the spec here, could a small test be added?

Done - I've updated the `@return` to split it into separate sentences and also updated an existing test to include the testing for `HttpExchange.getAttribute()` and `setAttribute()`. The test continues to pass. I'll run it through our CI too.

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/22454#discussion_r1863510065


More information about the net-dev mailing list