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.

216 questions
1
vote
0 answers

maven-javadoc-plugin has issues with package-info.java and annotations

I get the following error message: Error: Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.3.2: jar (attach-javadocs) on project: MavenReportException: Error while generating Javadoc: Error: Exit code: 1 -…
Werner Daehn
  • 577
  • 6
  • 16
1
vote
0 answers

maven-javadoc-plugin not showing private methods

I have a multi-module maven project and I am wanting to aggregate a javadoc that combines all the methods (public and private) into a whole javadoc. It seems simple, I am following the instructions here:…
E.S.
  • 2,733
  • 6
  • 36
  • 71
1
vote
0 answers

Javadoc issue package does not exist in java11

Javadoc says package doesnt exist in all the imports. This same setup worked for Java1.8 but with java 11 it has this issue [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9:jar (attach-javadocs) on project esymac:…
Shruti
  • 23
  • 4
1
vote
1 answer

Plugin 'org.apache.maven.plugins:maven-javadoc-plugin:3.2.0' not found

I'm currently making a Spigot plugin and to build this plugin, I use the Lifecycle Package build. The Spigot Plugin I'm making is actually an API so naturally I would want to include JavaDocs with it. The thing is, I already made the JavaDocs, I…
aydinasf
  • 11
  • 2
1
vote
0 answers

intellij maven javadoc plugin JAVA_HOME not set error

I added maven source and javadoc plugins to an application pom.xml which is built in Intellij, in order to deploy the sources and javadocs to nexus along with the jar files. But the Javadoc plugin would not run, gave this error Failed to execute…
stephen newman
  • 533
  • 4
  • 17
1
vote
1 answer

Maven Javadoc warnings become errors in GitLab CI

When I run mvn javadoc:javadoc locally, it gives me a bunch of warnings—empty @return tags, unknown tags etc.—but eventually builds the Javadoc tree. On GitLab CI, I have the following in .gitlab-ci-yml: variables: MAVEN_OPTS:…
user149408
  • 5,385
  • 4
  • 33
  • 69
1
vote
0 answers

How do I generate JavaDocs for non-exported packages in a module?

I am currently writing a JavaFX application contained within 1 module and I want to use Javadoc to document all of my code. However, I am noticing that I can't seem to generate Javadocs for packages that have not been exported out of the module in…
UrbenLegend
  • 341
  • 4
  • 6
1
vote
1 answer

How to fix all tags and issues in Javadoc, excluding certain tags?

I am migrating old Ant projects to Maven. There are some issues with Javadoc for newer versions of Java, so I am fixing it by mvn javadoc:fix. The issue that the plugin itself adds author and version tags. I want to exclude them. Maven Javadoc…
Dmytro Chasovskyi
  • 3,209
  • 4
  • 40
  • 82
1
vote
1 answer

Generate Javadoc for multimodule project

I have read everything I can find on solving this and my attempts still fail. The best I can do is to get the Javadoc of exactly one module to show up--the last one built. (For now, I'm not trying to bundle Javadoc into any JARs. I'm also not trying…
Russ Bateman
  • 18,333
  • 14
  • 49
  • 65
1
vote
1 answer

Ignore Sibling-Modules During Maven Javadoc/Site Compilation

I have a Maven-managed project which contains a few modules, one of which is the actual library of interest. The other modules are just add-ons or examples that build off of the library. I'm looking to generate the Maven site for this library and…
Jake Wharton
  • 75,598
  • 23
  • 223
  • 230
1
vote
0 answers

maven-javadoc-plugin ignores dependencyManagement

I have a large multi-module maven project that needs to be built offline so it can't just download its dependencies. The project builds successfully, but I am having issues getting the maven-site-pugin/maven-javadoc-plugin to generate the javadocs.…
Sam
  • 322
  • 2
  • 11
1
vote
0 answers

Can I modify Javadoc comments generated by maven-javadoc-plugin 2.10.4?

When I build a maven project, using maven-javadoc-plugin 2.10.4, it generates the .java files with some Javadoc comments that look something like: <complexType> <complexContent> etc... The problem is the doclint for Java 8 can't handle the…
user1844160
  • 303
  • 1
  • 3
  • 10
1
vote
0 answers

Maven JavaDoc Plugin Failing to parse XML

I have trying to generate Javadoc using the maven-javadoc-plugin and a custom doclet. I am using JDK 11 and I have implemented the methods of the Doclet interface. However, in one of the methods, I am trying to unmarshal an XML file. I am receiving…
1
vote
0 answers

Generating Javadoc in Maven does give errors because of proxy

I'm trying to generate my javadoc using Maven to use in SpringFox Swagger. When I generate the Javadoc using Maven I got an error like: Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.0:javadoc (default) on project…
JimmyD
  • 2,629
  • 4
  • 29
  • 58
1
vote
1 answer

configure javadoc links in offline mode to link to local copy

How do I create javadocs that link to files in the local filesystem in offline mode? I am building javadocs for a java package and want the links of external packages (including java.lang) to point to a local copy. This works by setting the links…
carandraug
  • 12,938
  • 1
  • 26
  • 38