Stack Overflow
Stack Overflow

Questions tagged [maven-javadoc-plugin]

The Maven Javadoc Plugin uses the Javadoc tool to generate javadocs for the specified project.

The documentation on the Maven Java Doc plugin can be used to read more in detail how the javadoc plugin works and how to configure particular areas of the JavaDoc generation for a project.

193 questions
261
votes
5 answers

How can I disable the Maven Javadoc plugin from the command line?

In pom.xml I have declaration like this org.apache.maven.plugins maven-javadoc-plugin attach-javadocs …
IAdapter
  • 55,820
  • 69
  • 166
  • 236
86
votes
9 answers

JDK8 - Error "class file for javax.interceptor.InterceptorBinding not found" when trying to generate javadoc using Maven javadoc plugin

I am using JDK8 (tried it on my Eclipse workspace with Win x64 u25 JDK + on Linux launched by Jenkins - jdk-8u20-linux-x64, same problem for both). I have multi-module Maven project (I am launching Maven goal "javadoc:aggregate" from a main module…
Michal Aron
  • 885
  • 1
  • 6
  • 7
59
votes
2 answers

Generate Javadoc HTML using maven?

Right now I am using the maven-javadoc-plugin to attach the Javadoc to .jar artifacts when I am doing a release. However, how can I generate the Javadoc in an html format so we can scp it to a remote server for reference? Thanks!
Sam Levin
  • 3,015
  • 7
  • 24
  • 43
46
votes
8 answers

JDK 11+ and Javadoc

Exit code: 1 - javadoc: error - The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/11/docs/api/ are in named modules. Has anyone been able to make javadoc work without…
Rafael Ibasco
  • 1,048
  • 2
  • 13
  • 19
44
votes
6 answers

Is there a way to speed up Javadoc (takes 7 minutes)

I am building a Javadoc for a module with 2,509 classes. This currently takes 7 min or 6 files per second. I have tried mvn -T 1C install However javadoc only uses 1 CPU. Is there a way to use more and/or speed up? I am using Oracle JDK 8 update…
Peter Lawrey
  • 498,481
  • 72
  • 700
  • 1,075
38
votes
4 answers

How to continuously build and deploy feature branches with Maven?

My team is using feature branches to implement new features and continuously deploys snapshot builds into a remote repo for our users to use. Thus 'deploy' really only means 'distributing to a remote Maven repository'. We're currently only running…
Oliver Drotbohm
  • 71,632
  • 16
  • 205
  • 196
34
votes
3 answers

Lombok Maven javadoc:aggregate report with generated sources

I have a multimodule java project built with Maven to which I want to generate javadocs with javadoc:aggregate. The project structure looks like: parent ├─lomboklib └─other I am also using Project Lombok to generate some methods in the project. I…
Eero Aaltonen
  • 3,571
  • 1
  • 21
  • 38
27
votes
6 answers

How to disable Javadoc warnings in Maven Javadoc Plugin?

I'm using the Maven Javadoc Plugin. It outputs warnings as follows: [ERROR] /home/monperrus/spoon/src/main/java/spoon/visitor/CtVisitor.java:144: warning: no @param for How to display those warnings as [WARNING] (and not the confusing…
Martin Monperrus
  • 1,375
  • 1
  • 14
  • 23
22
votes
2 answers

Javadoc "cannot find symbol" error when using Lombok's @Builder annotation

I have a class looking as below : @Data @Builder public class Foo { private String param; /** My custom builder.*/ public static FooBuilder builder(String _param){ return builder().param(_param); } } I get the following…
yunandtidus
  • 3,136
  • 2
  • 24
  • 38
21
votes
3 answers

Can't link to JDK10 in Javadoc comments

After upgrading from Java 9 to 10, links to the JDK no longer work when generating documentation with the Javadoc tool (e.g., for a file importing java.util.Optional, {@link Optional} renders as Optional instead of as Optional; same issue with @see,…
gdejohn
  • 6,648
  • 1
  • 30
  • 45
11
votes
5 answers

Using Eclipse compiler instead of javac results in javadoc crash

Summary: I've run into an interesting problem, and I'm not quite sure how to sleuth it: Our project has been building fine for months I changed the maven-compiler-plugin to use the eclipse compiler instead of javac Now when I run mvn site,…
Daniel Pryden
  • 54,536
  • 12
  • 88
  • 131
11
votes
2 answers

How to avoid calling javadoc more than once if creating a site?

I would like to deploy an artifact together with javadoc and a Maven site. I use clean javadoc:jar site deploy site:deploy (the split between site and site:deploy is just to avoid the deployment of a site if deploy fails). Now the javadoc is…
J Fabian Meier
  • 26,766
  • 8
  • 52
  • 98
11
votes
3 answers

Maven site (Maven 3) generates empty site folder

I'm attempting to create a basic maven site using the maven site plugin. So I added this to my pom: org.apache.maven.plugins …
TheLQ
  • 14,081
  • 11
  • 66
  • 104
11
votes
6 answers

Javadoc generation failed : ClassCastException: com.sun.tools.javadoc.ClassDocImpl cannot be cast to com.sun.javadoc.AnnotationTypeDoc

I'm getting the following error when I do mvn clean deploy -DperformRelease=true [ERROR] Exit code: 1 - .java:3: package javax.inject does not exist [ERROR] import javax.inject.Named; [ERROR] ^ [ERROR] TransactionServiceExternalImpl.java:5:…
jeff porter
  • 6,196
  • 13
  • 59
  • 112
9
votes
1 answer

How to generate Javadoc for Maven Dependencies

I have a maven project with the following POM snippet: 4.0.0 Foo-Deploy Foo-Deploy pom foobar …
Emerson
  • 1,247
  • 2
  • 15
  • 24
1
2 3
…
12 13