maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "William Collishaw (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (MJAVADOC-605) Exclude packages does not work as described in documentation
Date Tue, 21 May 2019 05:41:00 GMT

     [ https://issues.apache.org/jira/browse/MJAVADOC-605?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

William Collishaw updated MJAVADOC-605:
---------------------------------------
    Description: 
This functionality worked in 3.0.1 and failed after upgrading to 3.1.0
 The following syntax is shown in the [documentation|[https://maven.apache.org/plugins/maven-javadoc-plugin/examples/exclude-package-names.html]]
:

<excludePackageNames>com.mycompany.myapp.package1.*:com.mycompany.myapp.package2:*.util.*</excludePackageNames>

In this example the documentation states that the following packages are excluded:
 * com.mycompany.myapp.package2
 * com.mycompany.myapp.package2.subpackage4
 * com.mycompany.myapp.package2.subpackage5
 * com.mycompany.myapp.package2.util

This was correct in 3.0.1, however since upgrading to 3.1.0, the following behavior is observed:

+*Scenario 1* (which does not match current documentation)+
{code:java}
<excludePackageNames>com.mycompany.myapp.package2</excludePackageNames>{code}
 +Excluded+
 * com.mycompany.myapp.package2

 +Included+
 * com.mycompany.myapp.package2.subpackage4
 * com.mycompany.myapp.package2.subpackage5
 * com.mycompany.myapp.package2.util

+*Scenario 2* (This matches documentation scenario)+
{code:java}
<excludePackageNames>com.mycompany.myapp.package2.*</excludePackageNames>{code}
 +Excluded+
 * com.mycompany.myapp.package2.subpackage4
 * com.mycompany.myapp.package2.subpackage5
 * com.mycompany.myapp.package2.util

 +Included+
 * com.mycompany.myapp.package2

 

+*Scenario 3* (This is the current workaround)+
{code:java}
<excludePackageNames>com.mycompany.myapp.package2:com.mycompany.myapp.package2.*</excludePackageNames>{code}
 +Excluded+
 * com.mycompany.myapp.package2
 * com.mycompany.myapp.package2.subpackage4
 * com.mycompany.myapp.package2.subpackage5
 * com.mycompany.myapp.package2.util

  was:
This functionality worked in 3.0.1 and failed after upgrading to 3.1.0
 The following syntax is shown in the [documentation|[https://maven.apache.org/plugins/maven-javadoc-plugin/examples/exclude-package-names.html]]:
{code:java}
<excludePackageNames>com.mycompany.myapp.package1.*:com.mycompany.myapp.package2:*.util.*</excludePackageNames>
{code}
In this example the documentation states that the following packages are excluded:
 * com.mycompany.myapp.package2
 * com.mycompany.myapp.package2.subpackage4
 * com.mycompany.myapp.package2.subpackage5
 * com.mycompany.myapp.package2.util

This was correct in 3.0.1, however since upgrading to 3.1.0, the following behavior is observed:

+*Scenario 1* (which does not match current documentation)+
{code:java}
<excludePackageNames>com.mycompany.myapp.package2</excludePackageNames>{code}
 +Excluded+
 * com.mycompany.myapp.package2

 +Included+
 * com.mycompany.myapp.package2.subpackage4
 * com.mycompany.myapp.package2.subpackage5
 * com.mycompany.myapp.package2.util

+*Scenario 2* (This matches documentation scenario)+
{code:java}
<excludePackageNames>com.mycompany.myapp.package2.*</excludePackageNames>{code}
 +Excluded+
 * com.mycompany.myapp.package2.subpackage4
 * com.mycompany.myapp.package2.subpackage5
 * com.mycompany.myapp.package2.util

 +Included+
 * com.mycompany.myapp.package2

 

+*Scenario 3* (This is the current workaround)+
{code:java}
<excludePackageNames>com.mycompany.myapp.package2:com.mycompany.myapp.package2.*</excludePackageNames>{code}
 +Excluded+
 * com.mycompany.myapp.package2
 * com.mycompany.myapp.package2.subpackage4
 * com.mycompany.myapp.package2.subpackage5
 * com.mycompany.myapp.package2.util


> Exclude packages does not work as described in documentation
> ------------------------------------------------------------
>
>                 Key: MJAVADOC-605
>                 URL: https://issues.apache.org/jira/browse/MJAVADOC-605
>             Project: Maven Javadoc Plugin
>          Issue Type: Bug
>    Affects Versions: 3.1.0
>            Reporter: William Collishaw
>            Priority: Major
>
> This functionality worked in 3.0.1 and failed after upgrading to 3.1.0
>  The following syntax is shown in the [documentation|[https://maven.apache.org/plugins/maven-javadoc-plugin/examples/exclude-package-names.html]]
:
> <excludePackageNames>com.mycompany.myapp.package1.*:com.mycompany.myapp.package2:*.util.*</excludePackageNames>
> In this example the documentation states that the following packages are excluded:
>  * com.mycompany.myapp.package2
>  * com.mycompany.myapp.package2.subpackage4
>  * com.mycompany.myapp.package2.subpackage5
>  * com.mycompany.myapp.package2.util
> This was correct in 3.0.1, however since upgrading to 3.1.0, the following behavior is
observed:
> +*Scenario 1* (which does not match current documentation)+
> {code:java}
> <excludePackageNames>com.mycompany.myapp.package2</excludePackageNames>{code}
>  +Excluded+
>  * com.mycompany.myapp.package2
>  +Included+
>  * com.mycompany.myapp.package2.subpackage4
>  * com.mycompany.myapp.package2.subpackage5
>  * com.mycompany.myapp.package2.util
> +*Scenario 2* (This matches documentation scenario)+
> {code:java}
> <excludePackageNames>com.mycompany.myapp.package2.*</excludePackageNames>{code}
>  +Excluded+
>  * com.mycompany.myapp.package2.subpackage4
>  * com.mycompany.myapp.package2.subpackage5
>  * com.mycompany.myapp.package2.util
>  +Included+
>  * com.mycompany.myapp.package2
>  
> +*Scenario 3* (This is the current workaround)+
> {code:java}
> <excludePackageNames>com.mycompany.myapp.package2:com.mycompany.myapp.package2.*</excludePackageNames>{code}
>  +Excluded+
>  * com.mycompany.myapp.package2
>  * com.mycompany.myapp.package2.subpackage4
>  * com.mycompany.myapp.package2.subpackage5
>  * com.mycompany.myapp.package2.util



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message