You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Richard Sand (JIRA)" <ji...@apache.org> on 2019/01/15 03:38:00 UTC
[jira] [Updated] (MJAVADOC-564) Generated javadoc tags in fix goal
are not in proper order
[ https://issues.apache.org/jira/browse/MJAVADOC-564?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Richard Sand updated MJAVADOC-564:
----------------------------------
Description:
The javadoc:fix goal is placing/moving the @throws tags to the bottom of the tags, which isn't the proper order if there is a since tag.
Example:
{{ /**}}
{{ * <p>initialize.</p>}}
{{ *}}
{{ * @param keyClass a \{@link java.lang.Class} object.}}
{{ * @param valueClass a \{@link java.lang.Class} object.}}
{{ * @throws com.idfconnect.ssorest.cache.CacheException if any.}}
{{ * @since 3.1.4}}
{{ */}}
Get changed to:
{{ /**}}
{{ * <p>initialize.</p>}}
{{ *}}
{{ * @param keyClass a \{@link java.lang.Class} object.}}
{{ * @param valueClass a \{@link java.lang.Class} object.}}
{{ * @since 3.1.4}}
{{ * @throws com.idfconnect.ssorest.cache.CacheException if any.}}
{{ */}}
The exact order of tags is documented here for reference:
[https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#orderoftags]
was:
The javadoc:fix goal is placing/moving the @throws tags to the bottom of the tags, which isn't the proper order if there is a since tag.
Example: {{}}
{{ /**}}
{{ * <p>initialize.</p>}}
{{ *}}
{{ * @param keyClass a \{@link java.lang.Class} object.}}
{{ * @param valueClass a \{@link java.lang.Class} object.}}
{{ * @throws com.idfconnect.ssorest.cache.CacheException if any.}}
{{ * @since 3.1.4}}
{{ */}}
Get changed to:
{{ /**}}
{{ * <p>initialize.</p>}}
{{ *}}
{{ * @param keyClass a \{@link java.lang.Class} object.}}
{{ * @param valueClass a \{@link java.lang.Class} object.}}
{{ * @since 3.1.4}}
{{ * @throws com.idfconnect.ssorest.cache.CacheException if any.}}
{{*/}}
The exact order of tags is documented here for reference:
[https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#orderoftags]
> Generated javadoc tags in fix goal are not in proper order
> ----------------------------------------------------------
>
> Key: MJAVADOC-564
> URL: https://issues.apache.org/jira/browse/MJAVADOC-564
> Project: Maven Javadoc Plugin
> Issue Type: Bug
> Components: fix
> Affects Versions: 2.10.4, 3.0.1
> Reporter: Richard Sand
> Priority: Major
>
> The javadoc:fix goal is placing/moving the @throws tags to the bottom of the tags, which isn't the proper order if there is a since tag.
> Example:
> {{ /**}}
> {{ * <p>initialize.</p>}}
> {{ *}}
> {{ * @param keyClass a \{@link java.lang.Class} object.}}
> {{ * @param valueClass a \{@link java.lang.Class} object.}}
> {{ * @throws com.idfconnect.ssorest.cache.CacheException if any.}}
> {{ * @since 3.1.4}}
> {{ */}}
> Get changed to:
> {{ /**}}
> {{ * <p>initialize.</p>}}
> {{ *}}
> {{ * @param keyClass a \{@link java.lang.Class} object.}}
> {{ * @param valueClass a \{@link java.lang.Class} object.}}
> {{ * @since 3.1.4}}
> {{ * @throws com.idfconnect.ssorest.cache.CacheException if any.}}
> {{ */}}
> The exact order of tags is documented here for reference:
> [https://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#orderoftags]
>
>
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)