[jira] [Comment Edited] (MJAVADOC-548) Misleading Setting "excludePackageNames"

["Jesko Jochum (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/MJAVADOC-548?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16708355#comment-16708355 ] 

Jesko Jochum edited comment on MJAVADOC-548 at 12/4/18 8:16 AM:
----------------------------------------------------------------

How do you mean?

I do not have any colons, commas or semicolons in my {{excludePackageNames}}, because I do not have anything else to exclude. You could also change the value to {{\*.temp.\*:}} or {{\*.temp}} or {{\*.temp.\*:org.acme.exclude1.\*}} without a change in the error caused by the project being inside a folder named {{temp}}.

Anyways, I copied the given example setting {{<excludePackageNames>\*.internal:org.acme.exclude1.\*:org.acme.exclude2</excludePackageNames>}}, renamed the folder my project resides in from {{D:\temp}} to {{D:\internal}}, and I have the same result of no javadoc being generated.

Please see the attached example [^mjavadoc-548-example.zip], with my project already residing inside a folder called {{internal}}. Extract the files and run {{mvn javadoc:jar}} inside the project folder {{mjavadoc-548-example}} and you will see that no javadoc is generated. Move the project out of the folder called {{internal}} and run {{mvn javadoc:jar}} inside the project folder again, and you will see the javadoc is generated as expected.


was (Author: jejo86):
How do you mean?

I do not have any colons, commas or semicolons in my {{excludePackageNames}}, because I do not have anything else to exclude. You could also change the value to {{*.temp.*:}} or {{*.temp}} or {{*.temp.*:org.acme.exclude1.*}} without a change in the error caused by the project being inside a folder named {{temp}}.

Anyways, I copied the given example setting {{<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>}}, renamed the folder my project resides in from {{D:\temp}} to {{D:\internal}}, and I have the same result of no javadoc being generated.

Please see the attached example [^mjavadoc-548-example.zip], with my project already residing inside a folder called {{internal}}. Extract the files and run {{mvn javadoc:jar}} inside the project folder {{mjavadoc-548-example}} and you will see that no javadoc is generated. Move the project out of the folder called {{internal}} and run {{mvn javadoc:jar}} inside the project folder again, and you will see the javadoc is generated as expected.

> Misleading Setting "excludePackageNames"
> ----------------------------------------
>
>                 Key: MJAVADOC-548
>                 URL: https://issues.apache.org/jira/browse/MJAVADOC-548
>             Project: Maven Javadoc Plugin
>          Issue Type: Improvement
>          Components: javadoc
>    Affects Versions: 2.10.4, 3.0.1
>         Environment: Windows 7 x64
> Apache Maven 3.5.4
>            Reporter: Jesko Jochum
>            Priority: Minor
>         Attachments: mjavadoc-548-example.zip
>
>
> The setting {{excludePackageNames}} is not working, as I would expect, or should be renamed to something like {{excludePathNames}} with an updated description, to reveal what it is really doing.
> I have the default layout for the sources, i.e. they get stored in the {{${project.basedir}\src\main\java}} subfolder of my project.
>  For testing purposes I sometimes create classes in the subpackage {{my.companyname.temp}}, which I do not want to have included in the generated javadoc, why I use the following {{excludePackageNames}} setting:
> {noformat}
> ...
> <!-- Exclude files in temporary packages -->
> <excludePackageNames>*.temp.*</excludePackageNames>
> ...
> {noformat}
> in my {{pom.xml}}.
> By doing this, I wanted to exclude all .java sources in the folders {{${project.basedir}\src\main\java*\temp*}} from the javadoc generation, but what I got was an exclusion of all .java sources, if there is a subfolder with the name {{temp}} in any segment of the path, even in the {{$\{project.basedir}}}.
> So, after moving the project into e.g. the folder {{D:\temp\}} no javadoc gets generated at all.



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