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
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,560
  • 13
  • 65
  • 123
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,327
  • 2
  • 15
  • 24
9
votes
1 answer

How to avoid duplicate forking when generating aggregated javadoc in a multimodule project

I am trying to configure a Maven multimodule project to produce a distribution zip via the assembly plugin, which should include aggregated javadoc for all submodules in the project. The project structure is (simplified, in reality there's about 20…
Jeen Broekstra
  • 21,642
  • 4
  • 51
  • 73
9
votes
1 answer

How to skip test api docs in maven-javadoc-plugin?

I would like to skip generating 'testapidocs' folder in my 'target/site' folder after executing 'clean skip:skip' with following configuration. Build Configuration: ................. …
Jagadeesh
  • 2,730
  • 6
  • 30
  • 45
9
votes
2 answers

Maven "Skipping javadoc generation" WHY?

I'm working on a maven project and want to generate the most basic of javadocs. This is the plugin I add to my pom.xml org.apache.maven.plugins …
Daniel
  • 105
  • 1
  • 2
  • 5
8
votes
1 answer

How to properly link to a modularized dependency using the Maven Javadoc Plugin?

In my project, I'm trying to include links to a modularized Java library (Caesar) in the documentation files generated by the javadoc tool. Running: mvn clean install builds the docs without links to the external library. My…
Janez Kuhar
  • 3,705
  • 4
  • 22
  • 45
8
votes
3 answers

How to enable maven profile when built version is not -SNAPSHOT?

I'm trying to use the gitflow-helper-maven-plugin extension for my maven builds. Therefore I'd like to configure my project in order to run some extra steps when building a release version and skipping them while compiling a SNAPSHOT one, but I…
conteit86
  • 320
  • 3
  • 16
7
votes
1 answer

maven 3 javadoc plugin doesn't take the excludepackagename config

I'm trying to exclude a bunch of packages from a javadoc site. Unfortunately this plugin seems to live its own life and when it was configured as a report plugin it failed with access denied when moving files, so it was changed to be a normal…
Sven
  • 892
  • 14
  • 29
7
votes
1 answer

How to make Maven Javadoc Plugin work with any Java version

I'm using Maven Javadoc Plugin like this org.apache.maven.plugins maven-javadoc-plugin 3.1.1 …
John29
  • 3,340
  • 3
  • 32
  • 50
7
votes
1 answer

swagger-maven-plugin triggers Javadoc warning: element value must be a constant expression (but it is!) in Java annotation

Javadoc (via Maven) is giving me the following error in one my Java JAX-RS interface method signatures: error: element value must be a constant expression Here is my JAX-RS interface: public interface FooResource { …
Garret Wilson
  • 18,219
  • 30
  • 144
  • 272
7
votes
2 answers

maven-javadoc-plugin and inheritDoc for Java API core classes

I am writing my own Java 8 Stream implementation and want to inherit the Javadocs from the original java.util.stream.Stream interface. However I cannot get it working. The generated Javadoc does only show my documentation but not the documentation…
Stefan Ferstl
  • 5,135
  • 3
  • 33
  • 41
7
votes
4 answers

How to make Maven build (goal site) fail on Javadoc warnings?

I am building my Maven project with the goal site. There are Javadoc warnings in the output. In this case my Maven build has to fail. Is there a way to do that? Here is the code snippet of my POM (I am using Maven 3.3): …
Mueller2016
  • 195
  • 1
  • 9
7
votes
5 answers

Maven, javadoc : No source files for package

I'm writing a maven package with directory structure frtex pom.xml frtex/src/main/java/some-files.java frtex/src/main/java/utils/some-other-files.java Making mvn test works fine. My problem is mvn javadoc:javadoc that produces the right…
Laurent Claessens
  • 547
  • 1
  • 3
  • 18
7
votes
3 answers

How do I make javadoc inheritance work for external APIs? (with Maven2)

When a class overrides a concrete method or implements and abstract method, the Javadoc is automatically inherited unless explicitly overwritten. Or, at least the tool tries to do this. It seems it does not work for linked external APIs. For…
Chris Vest
  • 8,642
  • 3
  • 35
  • 43
7
votes
0 answers

Java 8 + Maven Javadoc plugin: Error fetching URL

I am attempting to generate Javadoc that actually links to the Javadoc for my dependencies. I have tried various means to generate Javadoc which does not produce the fully qualified class names for references to classes from my dependencies. I…
Selena
  • 2,208
  • 8
  • 29
  • 49
1
2
3
…
14 15