RFR: JDK-8263043: Add test to verify order of tag output

[Pavel Rappo]

On Fri, 5 Mar 2021 15:55:03 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> test/langtools/jdk/javadoc/doclet/testTagOrder/TestTagOrder.java line 76:
>> 
>>> 74:                          * @throws IllegalArgumentException well, never
>>> 75:                          * @since 1.0
>>> 76:                          * @see <a href="http://example.com">example</a>
>> 
>> Consider adding `@version` and `@author` standard tags to this test. Although JDK API documentation does not include those, API documentation of other projects might. Adding those tags will improve coverage.
>
> Hmmm ...
> Actually, my initial version of the code _did_ include `@author`, but not `@version`.  But, it didn't work as expected ... because neither are actually supported on methods, and so they do not appear in the output.  See https://docs.oracle.com/en/java/javase/15/docs/specs/javadoc/doc-comment-spec.html#where-tags-can-be-used
> 
> So, if you really think we should test these as well, we will have to extend the test to include comments on a class or interface declaration.

I looked at that table before suggesting to add those tags and realized that adding them would complicate the test, hence "consider". You could push the test as is and we will improve it later. It's up to you, Jon.

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

PR: https://git.openjdk.java.net/jdk/pull/2835