Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-24 Thread Kumar Srinivasan
Ok updated http://cr.openjdk.java.net/~ksrini/8178725/webrev.02/ In this changeset removed the override as Magnus suggested. Thanks Kumar On 2017-04-20 20:02, Jonathan Gibbons wrote: David, Magnus, Yes, this is somewhat Oracle-specific (more accurately it is JDK-specific, which is why this

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-20 Thread Kumar Srinivasan
Thanks for all the comments and feed back, I will go with what we have, for now, likely its not the last time we will be touching this before jdk9 is done. Kumar On 2017-04-20 20:02, Jonathan Gibbons wrote: David, Magnus, Yes, this is somewhat Oracle-specific (more accurately it is JDK-spe

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-20 Thread Jonathan Gibbons
On 4/20/17 2:53 PM, Magnus Ihse Bursie wrote: On 2017-04-20 20:02, Jonathan Gibbons wrote: David, Magnus, Yes, this is somewhat Oracle-specific (more accurately it is JDK-specific, which is why this is a proposed to be a JDK build-time taglet, and not a standard tag in the standard doclet),

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-20 Thread Magnus Ihse Bursie
On 2017-04-20 20:02, Jonathan Gibbons wrote: David, Magnus, Yes, this is somewhat Oracle-specific (more accurately it is JDK-specific, which is why this is a proposed to be a JDK build-time taglet, and not a standard tag in the standard doclet), but it is no worse than the explicit Oracle-spe

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-20 Thread Jonathan Gibbons
OK by me. -- Jon On 04/19/2017 10:46 AM, Kumar Srinivasan wrote: Have made the following changes: * fixed the indentations, basically pointed the IDE and asked it to reformat the whole file * fixed regex, to be defensive against leading WS, though the DocCommentParser whacks the WS. P

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-20 Thread Roger Riggs
Hi, An idea that might make it more flexible would be if the settable property used as the link used one of the familiar formatting substitution mechanisms so the id can be inserted in the link wherever it is needed. For example, the PrintStream formatting like %s. Alternatively, the {0} for

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-20 Thread Jonathan Gibbons
David, Magnus, Yes, this is somewhat Oracle-specific (more accurately it is JDK-specific, which is why this is a proposed to be a JDK build-time taglet, and not a standard tag in the standard doclet), but it is no worse than the explicit Oracle-specific URLs that have been used up to now, or

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-19 Thread Kumar Srinivasan
On 4/19/2017 1:37 PM, David Holmes wrote: On 20/04/2017 3:50 AM, Kumar Srinivasan wrote: We could potentially make the default URL to be "some" cgi url, and have the build system specify the URL all the time, in our case it would be the Oracle documentation URL. Would this be an acceptable a

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-19 Thread David Holmes
On 20/04/2017 3:50 AM, Kumar Srinivasan wrote: We could potentially make the default URL to be "some" cgi url, and have the build system specify the URL all the time, in our case it would be the Oracle documentation URL. Would this be an acceptable approach ? I'm not sure what you mean. I ha

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-19 Thread Kumar Srinivasan
We could potentially make the default URL to be "some" cgi url, and have the build system specify the URL all the time, in our case it would be the Oracle documentation URL. Would this be an acceptable approach ? Kumar On 19/04/2017 9:26 PM, Magnus Ihse Bursie wrote: On 2017-04-18 19:44, Ku

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-19 Thread Kumar Srinivasan
Have made the following changes: * fixed the indentations, basically pointed the IDE and asked it to reformat the whole file * fixed regex, to be defensive against leading WS, though the DocCommentParser whacks the WS. Please see updated webrev: http://cr.openjdk.java.net/~ksrini/8178725

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-19 Thread David Holmes
On 19/04/2017 9:26 PM, Magnus Ihse Bursie wrote: On 2017-04-18 19:44, Kumar Srinivasan wrote: Hello, As explained in the JBS issue [1], this new taglet enables API documents to contain the extLink tag to link external sources. Please review the webrev [2]. Changes looks good. Just a reflecti

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-19 Thread Magnus Ihse Bursie
On 2017-04-18 19:44, Kumar Srinivasan wrote: Hello, As explained in the JBS issue [1], this new taglet enables API documents to contain the extLink tag to link external sources. Please review the webrev [2]. Changes looks good. Just a reflection: This is heavily biased to Oracle documentation

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-18 Thread Jonathan Gibbons
The use of double quotes in the example might lead one to incorrectly believe that they are required. The example should work without the quotes: 43 /** 44 * An inline tag to conveniently insert an external link. 45 * The tag can be used as follows: 46 * {@extLink name description},

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-18 Thread Kumar Srinivasan
Thanks Erik, yes will wait for Magnus' and Jon's comments. Kumar The build change looks ok to me, but Magnus should definitely look at this since he is so heavily involved in the Javadoc build right now. /Erik On 2017-04-18 19:44, Kumar Srinivasan wrote: Hello, As explained in the JBS is

Re: Please review: JDK-8178725: provide way to link to external documentation

2017-04-18 Thread Erik Joelsson
The build change looks ok to me, but Magnus should definitely look at this since he is so heavily involved in the Javadoc build right now. /Erik On 2017-04-18 19:44, Kumar Srinivasan wrote: Hello, As explained in the JBS issue [1], this new taglet enables API documents to contain the extLink

Please review: JDK-8178725: provide way to link to external documentation

2017-04-18 Thread Kumar Srinivasan
Hello, As explained in the JBS issue [1], this new taglet enables API documents to contain the extLink tag to link external sources. Please review the webrev [2]. Thanks Kumar [1] https://bugs.openjdk.java.net/browse/JDK-8178725 [2] http://cr.openjdk.java.net/~ksrini/8178725/webrev.00/