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.

216 questions
3
votes
1 answer

Maven: Disabling javadoc generation for single module inside a multimodule project

I have a large multimodule project and I want to speed up my build. I've added this inside the build section of the pom.xml (belonging to the module I don't want the javadoc for) org.apache.maven.plugins …
Mandark
  • 798
  • 1
  • 12
  • 33
3
votes
2 answers

Alternate Output Directory for JavaDoc

I'm trying to configure an alternate output location for the JavaDocs in my multi-module maven project. I configured the maven-javadoc in the parent POM to look like this: ... org.apache.maven.plugins …
ktm5124
  • 11,861
  • 21
  • 74
  • 119
2
votes
2 answers

How to add a Javadoc JAR file to a Maven project in IntelliJ IDEA?

I am making a local Java utility library and building it into a JAR file. I am also building a JAR file for the Javadocs. These are the JAR files generated by Maven: Now, I am trying to use the Javadocs JAR file with IntelliJ IDEA by importing it…
Francis Rubio
  • 175
  • 4
  • 18
2
votes
1 answer

Javadoc with Java17 gives package X is declared in module Y error

I'm using maven-javadoc-plugin to produce Javadoc with Java 17. Since there is a class in my code that uses jdk.internal.reflect.Reflection class, Javadoc gives an error. I tried using to pass --add-opens flag but it's no use. …
velicanaydin
  • 31
  • 3
2
votes
0 answers

maven javadoc plugin: package doesn't exist when an external JAR is used

Not sure why Maven Javadoc Plugin reports: [ERROR] /project/src/main/a/b/SomeClass.java:3: error: package com.x does not exist [ERROR] import com.x.y; The plugin related part in pom.xml …
ka3ak
  • 2,435
  • 2
  • 30
  • 57
2
votes
2 answers

maven release:perform failing to even try to generate javadoc or sources

Since moving to Java 11 quite a while ago now, the maven release plugin fails to generate javadoc alongside the built artifact. My configuration for both in parent pom (and compiler plugin, in case relevant): …
nigelg
  • 151
  • 3
  • 12
2
votes
1 answer

Maven: how configure javadoc to generate all the private and package too

I am working with Maven 3.6.3, for a project based in one module, about the generation of the javadoc in the pom.xml file I have: org.apache.maven.plugins maven-javadoc-plugin …
Manuel Jordan
  • 15,253
  • 21
  • 95
  • 158
2
votes
1 answer

maven-javadoc-plugin: How to update the module path dynamically

I have a Java (11.0.7) Maven (3.0.6) multi-module project that contains the following module declarations: jdrum-commons jdrum-datastore-base jdrum-datastore-simple …
Roman Vottner
  • 12,213
  • 5
  • 46
  • 63
2
votes
1 answer

and allowed in JavaDoc pre-formatted text block?

I would like to use and in JavaDoc for a better formatting. However, it seems that JavaDoc is struggling with those elements. At least the maven-javadoc-plugin floods with such warning messages. Java 11 should support and …
pitschr
  • 156
  • 1
  • 8
2
votes
1 answer

How to include and link to external javadocs

I'm currently generating javadocs for a project which relies heavily on some external libraries such as guava. All of the dependencies are listed in the pom.xml and to avoid having to manually update links every time a library version is changed I'd…
Hunter Jackson
  • 315
  • 2
  • 10
2
votes
0 answers

Add module documentation to a maven module

I'm trying to add module documentation to maven modules of my project (like I would do in the module-info.java file of my modules). Is there a way to the doc in my module's POM file or to add the module-info file without needing to re-add all the…
William A.
  • 425
  • 5
  • 14
2
votes
1 answer

Maven javadoc plugin fix only existing javadocs

I am trying to fix javadocs for my project (mainly missing @param and @return values), and since there quite a lot of code to fix, I am trying to use javadoc:fix goal: mvn javadoc:fix Unfortunately, it generates javadocs even for classes that had…
CrazySabbath
  • 1,274
  • 3
  • 11
  • 33
2
votes
2 answers

Increase the number of reported Javadoc errors and warning when building with Maven

I am using Maven to build a project which has somewhat suboptimal Javadoc comments. I have noticed that no matter how many warnings I fix, I always get only 100 warnings reported: Building index for all the packages and classes... Generating…
lexicore
  • 42,748
  • 17
  • 132
  • 221
2
votes
1 answer

Javadoc warning - bad source file: file does not contain class com.example.MyClass

I have a file called MyFile.java and it contains multiple classes(none of them is public). Note that the file does not contain MyFile class. Apparently Javadoc is not happy about this and it generates a warning saying file does not contain class…
John
  • 21
  • 3
2
votes
0 answers

Maven Javadoc Plugin not finding custom taglets

I created some custom JavaDoc Taglets as described here: http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html They work correctly with the Maven Javadoc Plugin when I manually specify the Taglets classes: …
jamp
  • 2,159
  • 1
  • 17
  • 28
1 2 3
…
14 15