Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

sourceFileExcludes tag in the maven-javadoc-plugin

Tags:

maven

javadoc

Does anyone has an example how to use the sourceFileExcludes element in the Maven Javadoc Plugin? I've tried the following, but cannot get it to work:

<sourceFileExcludes>
    <sourceFileExclude>**/internal/*</sourceFileExclude>
    <sourceFileExclude>**/Model/*</sourceFileExclude>
</sourceFileExcludes>
like image 864
Peter Avatar asked Nov 20 '12 02:11

Peter


People also ask

What is the use of Maven Javadoc plugin?

It executes the standard Javadoc tool and supports the parameters used by the tool. javadoc:test-javadoc generates the test Javadoc files for the project. It executes the standard Javadoc tool and supports the parameters used by the tool. javadoc:javadoc-no-fork generates the Javadoc files for the project.

What is Maven Javadoc skip?

skip Option. The Maven Javadoc plugin has provided a maven. javadoc. skip option to skip the Javadoc generation. Our Maven build won't generate Javadocs if we pass this option with the value true when we build our project: mvn clean install -Dmaven.javadoc.skip=true.

Which will prevent Javadoc from being generated while using Doclint?

The magic incantation you need is -Xdoclint:none . This goes on the command line invoking Javadoc.


1 Answers

Have you specified excludePackageNames, cause based on the docs you should use them instead of what you've written.

<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>

which seemed to be more approriate.

like image 161
khmarbaise Avatar answered Oct 20 '22 23:10

khmarbaise