On Wed, 4 Nov 2020 20:57:06 GMT, Jonathan Gibbons <j...@openjdk.org> wrote:
>> This introduces support for a new `@spec` tag that can be used as either an
>> inline tag or as a block tag. It is used to identify references to external
>> specifications, in such a way that the references can be collected together
>> on a new summary page, called "Other Specifications", available from either
>> the static INDEX page or the interactive search box.
>>
>> As an inline tag, the format is `{@spec url label}`, which is roughly
>> translated to `<a href="url">label</a>` in the generated docs.
>>
>> As a block tag, the format is simply
>>
>> @spec url label
>>
>> which is handled in a manner analogous to
>>
>> @see <a href="url">label</a>
>>
>> The tag is notable for being the first standard/supported tag that can be
>> used as either an inline or block tag. (We have had support for bimodal
>> non-standard/custom tags for a while, such as `{@jls}` and `{@jvms}`.) To
>> support bimodal standard tags, some changes to `DocCommentParser` are
>> incorporated here.
>>
>> This change is only the _support_ for the new tag; it does _not_ include
>> any changes to API docs to _use_ the new tag.
>
> Jonathan Gibbons has updated the pull request with a new target base due to a
> merge or a rebase. The pull request now contains 11 commits:
>
> - Fix merge issues; review feedback
> - Merge with master
> - allow rich content in createAnchorAndSearchIndex
> - update Docs.gmk to stop disabling spec tag
> - fix TestSpecTag.testEncodedURI
> - fix tests
> - remove support to workaround legacy @spec tag
> - Merge remote-tracking branch 'upstream/master' into new-spec-tag
> - fix trailing whitespace in test
> - temporarily allow existing legacy usage `@spec JPMS` `@spec jsr-51`
> - ... and 1 more:
> https://git.openjdk.java.net/jdk/compare/804bd725...ed5512d9
src/jdk.compiler/share/classes/com/sun/source/util/DocTreeFactory.java line 309:
> 307: * Creates a new {@code SpecTree} object, to represent a {@code
> @spec} tag.
> 308: *
> 309: * @param inline whether this is instance is an inline tag
Should be:
`* @param inline whether this instance is an inline tag`
-------------
PR: https://git.openjdk.java.net/jdk/pull/790
