Please review: JDK-8178725: provide way to link to external documentation
Kumar Srinivasan
kumar.x.srinivasan at oracle.com
Wed Apr 19 17:46:33 UTC 2017
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/webrev.01/
Thanks
Kumar
On 4/18/2017 3:27 PM, Jonathan Gibbons wrote:
> 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}, for example
> 47 * <p>
> 48 * {@code
> 49 * Please see {@extLink Borealis a spectacular} sight.
> 50 * }
> 51 * <p>
> 52 * will produce the following html
> 53 * <p>
> 54 * {@code
> 55 * Please see <a
> href="https://www.oracle.com/pls/topic/lookup?ctx=javase9&id=Borealis">a
> spectacular</a> sight.
> 56 * }
> 57 * }
> 58 */
>
>
> The indentation in both the comment and the source code is a bit
> inconsistent. Is that an extra } on line 57?
>
> The regex will fail if there are too many spaces between "{@extLink"
> and the name. [1]
>
> -- Jon
>
>
> [1]:
> https://blog.codinghorror.com/regular-expressions-now-you-have-two-problems/
>
>
> On 04/18/2017 11:26 AM, Kumar Srinivasan wrote:
>>
>> 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 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/
>>>
>>
>
More information about the build-dev
mailing list