Re: RFR: 8296546: Add @spec tags to API [v3]

2022-12-01 Thread Jonathan Gibbons
On 11/28/22 3:27 PM, Phil Race wrote: On Wed, 23 Nov 2022 18:57:03 GMT, Jonathan Gibbons wrote: Please review a "somewhat automated" change to insert `@spec` tags into doc comments, as appropriate, to leverage the recent new javadoc feature to generate a new page listing the references to

Re: RFR: 8296546: Add @spec tags to API [v3]

2022-12-01 Thread Jonathan Gibbons
Mike, Thank you for the additional info. In general, the intent of this patch is to leverage the existing links in the doc comments, but given that there is now an intent to update those links as well, I have incorporated the change into the latest update. -- Jon On 11/28/22 7:14 PM,

Re: RFR: 8296546: Add @spec tags to API [v3]

2022-12-01 Thread Jonathan Gibbons
On Wed, 23 Nov 2022 23:04:36 GMT, Joe Wang wrote: >> Jonathan Gibbons has updated the pull request incrementally with one >> additional commit since the last revision: >> >> Remove updates from unexported files > > src/java.xml/share/classes/javax/xml/XMLConstants.java line 35: > >> 33: *

Re: RFR: 8296546: Add @spec tags to API [v3]

2022-11-29 Thread Michael StJohns
Hi - I need to repeat again.  Please avoid using www.ietf.org as the URL base for referencing RFCs.  The appropriate location is www.rfc-editor.org and is going to be more stable in the long run than any reference to an RFC that runs through the IETF's website.  These two websites have

Re: RFR: 8296546: Add @spec tags to API [v3]

2022-11-29 Thread Daniel Fuchs
We hear you Mike :-) I have logged https://bugs.openjdk.org/browse/JDK-8297755 to update the links in java.net / java.net.http API documentation. best regards, -- daniel On 29/11/2022 03:14, Michael StJohns wrote: Hi - I need to repeat again.  Please avoid using www.ietf.org as the URL base

Re: RFR: 8296546: Add @spec tags to API [v3]

2022-11-28 Thread Phil Race
On Wed, 23 Nov 2022 18:57:03 GMT, Jonathan Gibbons wrote: >> Please review a "somewhat automated" change to insert `@spec` tags into doc >> comments, as appropriate, to leverage the recent new javadoc feature to >> generate a new page listing the references to all external specifications >>

Re: RFR: 8296546: Add @spec tags to API [v3]

2022-11-24 Thread Alan Bateman
On Wed, 23 Nov 2022 18:57:03 GMT, Jonathan Gibbons wrote: >> Please review a "somewhat automated" change to insert `@spec` tags into doc >> comments, as appropriate, to leverage the recent new javadoc feature to >> generate a new page listing the references to all external specifications >>

Re: RFR: 8296546: Add @spec tags to API [v3]

2022-11-23 Thread Joe Wang
On Wed, 23 Nov 2022 18:57:03 GMT, Jonathan Gibbons wrote: >> Please review a "somewhat automated" change to insert `@spec` tags into doc >> comments, as appropriate, to leverage the recent new javadoc feature to >> generate a new page listing the references to all external specifications >>

Re: RFR: 8296546: Add @spec tags to API [v3]

2022-11-23 Thread Joe Wang
On Wed, 23 Nov 2022 18:57:03 GMT, Jonathan Gibbons wrote: >> Please review a "somewhat automated" change to insert `@spec` tags into doc >> comments, as appropriate, to leverage the recent new javadoc feature to >> generate a new page listing the references to all external specifications >>

Re: RFR: 8296546: Add @spec tags to API [v3]

2022-11-23 Thread Jonathan Gibbons
On Wed, 23 Nov 2022 19:20:53 GMT, Daniel Fuchs wrote: > The java.base/net/, java.http/, java.naming/ changes look reasonable to me - > though like Alan I wonder if it wouldn't be better to have an inline `{@spec > }` tag - similar to `{@systemProperty }`, rather than repeating all the >

Re: RFR: 8296546: Add @spec tags to API [v3]

2022-11-23 Thread Daniel Fuchs
On Wed, 23 Nov 2022 18:57:03 GMT, Jonathan Gibbons wrote: >> Please review a "somewhat automated" change to insert `@spec` tags into doc >> comments, as appropriate, to leverage the recent new javadoc feature to >> generate a new page listing the references to all external specifications >>

Re: RFR: 8296546: Add @spec tags to API [v3]

2022-11-23 Thread Jonathan Gibbons
> Please review a "somewhat automated" change to insert `@spec` tags into doc > comments, as appropriate, to leverage the recent new javadoc feature to > generate a new page listing the references to all external specifications > listed in the `@spec` tags. > > "Somewhat automated" means that