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
0
votes
1 answer

Is it possible to skip maven-javadoc-plugin execution in an Eclipse run configuration?

I have a few Maven projects in Eclipse 2019-6 that each include the maven-javadoc-plugin (v2.8) in their pom (which I don't want to modify), but in some cases I'd like to skip building the javadoc.jar when I run maven package or install through…
0
votes
1 answer

Maven Compile Plugin finds the dependencies but Maven Javadoc Plugin doesn't

I try to generate the Java API documentation of a project composed of multiple sub-modules with mvn site but it doesn't work whereas mvn install works, it resolves all dependencies and it compiles successfully. mvn site resolves neither the…
gouessej
  • 3,640
  • 3
  • 33
  • 67
0
votes
1 answer

An error has occurred in Javadoc report generation - unknown tag

I'm trying to generate the javadoc through maven by doing this mvn javadoc:javadoc javadoc:aggregate and here is the error Thats my function where the problem is: /** Divide 2 int * @param a int * @param b int * @return a / b if b != 0 * @throw…
Leon
  • 175
  • 1
  • 4
  • 13
0
votes
0 answers

maven-javadoc-plugin latest version issue

I am using maven-javadoc-plugin 3.0.1(latest version). When I try to generate site information (project reports and etc), the javadoc does not show links to the dependent classes. All I see is full class name and no linkage. When I use…
Andy
  • 11
  • 4
0
votes
2 answers

JavaDocs - adding hyperlink to each section and including a script tag for each html file

So I am using this plugin for generating javadocs: org.apache.maven.plugins maven-source-plugin 3.0.1
user5047085
0
votes
0 answers

Getting a RootDoc in jdk11

I am trying to test out some code that works with Java Doc, it is used under the maven-javadoc-plugin. I am trying to get it to work under jdk11. I am after an implementation of RootDoc which I can use when running tests. Currently the tests use…
Luke
  • 884
  • 8
  • 21
0
votes
2 answers

Who is responsible for docs and implementation of the JavaDoc-tool?

This question is related to an issue raised for Maven, which doesn't seem to escape paths forwarded to argument files supported by the JavaDoc-tool on Windows. The problem is that it's unclear from the documentation of JavaDoc itself how paths under…
Thorsten Schöning
  • 3,501
  • 2
  • 25
  • 46
0
votes
1 answer

Maven: Dependency-driven javadoc aggregation and custom doclet

I've prepared a very simple demo of what I would like to do in much bigger scale to demonstrate the issue: Configuration: java 1.8, maven 3.3.9, maven-javadoc-plugin 3.0.1 I've got maven artifacts testA, testB and testC. Component testA is a javadoc…
0
votes
1 answer

maven javadoc plugin throwing exception Exit code: 1 - javadoc: error - cannot read Input length = 1

maven jaavadoc plugin generates argument files: options and packages, but when javadoc is executed through this plugin following error appears: Exit code: 1 - javadoc: error - cannot read Input length = 1
devil00
  • 11
  • 1
  • 3
0
votes
1 answer

How to run Maven Javadoc in a project with pom packaging?

I have a project that packages the delivery of a software using the assembly plugin. The packaging of the project is pom. To make a nicer documentation i am using the dependency plugin to download the sources of the different projects and then…
xavipen
  • 229
  • 1
  • 11
0
votes
1 answer

Javadoc and maven: make class reference clickable when it point to another jar

I've two jars, one for interfaces and one for implementations. For example in the first jar i have: package com.myapp.jar1 public inteface MyInterface {...} in the second jar I have package com.myapp.jar2 import com.myapp.jar1.MyInterface public…
Daniele Licitra
  • 1,520
  • 21
  • 45
0
votes
1 answer

Maven Javadoc failed to find my subpackage - 'javadoc: warning - No source files for package'

I have this Maven project. I am trying to have Maven to automatically generate JavaDocs when mvn package is issued. The whole project compiles and packages just fine. It've generated documentation for all of my Java classes that are in the main…
Silence
  • 73
  • 3
  • 12
0
votes
2 answers

Site reports are missing after Javadoc configuration

I followed the advice of https://stackoverflow.com/a/16743137/927493 to deactivate the doclint check for sites, putting org.apache.maven.plugins maven-site-plugin
J Fabian Meier
  • 33,516
  • 10
  • 64
  • 142
0
votes
0 answers

Not able to link my javadocs with spring auto rest docs

I am not getting how do you use JavaDocs, with Spring Auto Rest Docs. I can generate my java-docs locally by using STS, UI option. However,i am not sure how to generate java-docs using Spring Auto Rest Docs. I tried writing some plugin in POM. But…
0
votes
0 answers

Error decoding percent encoded characters

I want to build a project and the following error occurs. My colleagues can build it without any problem. The error occurs since I've got a new laptop. Does somebody has any idea? >[INFO] Loading source files for package xxx... Loading source files…
Andre_R
  • 11
  • 4