Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [cross-project-issues-dev] Publishing javadoc via maven build

You have to configure the Maven Java Doc plugin to exclude files that meet a certain pattern.  So if you don't want it to include "internal" packages, you tell it to exclude these.

http://maven.apache.org/plugins/maven-javadoc-plugin/examples/exclude-package-names.html

You will need to setup a Configuration entry for your use of the maven javadoc plugin.

Dave


On 04/05/2011 10:18 AM, Ashwani Sharma wrote:
Hi David,

In most of the eclipse plugins we keep only one src directory i.e. 'src'
We put all out sources there - the one which are exposed via manifest and ones which are not exposed.
We normally want to publish the javadocs for exposed api's but the plugin publishes javadocs for all sources in src files. It can not differentiate between internal and external (exposed) sources.

One way to solve this can be to have different source folders like 'api' and 'core'. The put external sources in api folder, for which javadocs will be published.
Do you see any other way to solve this issue ?

Regards,
Ashwani Kr Sharma

On Tue, Apr 5, 2011 at 6:20 PM, David Carver <d_a_carver@xxxxxxxxx> wrote:
In most cases you want to skip javadoc for tests.  The main reason one has to do the work around is because the javadoc plugin expects sources to be in the standard maven format by default.  Eclipse plugins typically don't follow that format, so you have to specify the src directory in the build option.  The Maven Checkstyle plugin also requires this as well.

Dave


On 04/05/2011 03:14 AM, Ashwani Sharma wrote:
Hi,

I just found this link: http://swik.net/Eclipse/Planet+Eclipse/Dave+Carver%3A+Generating+JavaDoc+with+Maven+3+and+Tycho/ek4p3
Could be useful for others.

It works except for tests where is some issues with annotations.
Refer this link for that:
http://stackoverflow.com/questions/44853/why-am-i-getting-a-classcastexception-when-generating-javadocs

Best Regards,
Ashwani Kr Sharma

On Mon, Mar 28, 2011 at 7:41 PM, Ashwani Sharma <ashw.kumar@xxxxxxxxx> wrote:
Hi,

I am currently setting up javadoc publishing for our emf query2 projects.
We are using maven+tycho.

Is there anyone who is using similar setup and publishing javadoc for the projects ?

Thanks and Regards,
Ashwani Kr Sharma

_______________________________________________ cross-project-issues-dev mailing list cross-project-issues-dev@xxxxxxxxxxx https://dev.eclipse.org/mailman/listinfo/cross-project-issues-dev


_______________________________________________
cross-project-issues-dev mailing list
cross-project-issues-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/cross-project-issues-dev




Back to the top