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

maven-javadoc-plugin emits diagnostic messages as warnings

My github release workflow includes the maven-javadoc-plugin. This plugin emits a large number of warnings, but when I look at the messages, none of them is the slightest bit worrisome; they are all just diagnostic messages. It is as if some n00b is…
Mike Nakis
  • 56,297
  • 11
  • 110
  • 142
4
votes
2 answers

correctly render javadoc method links to external html javadoc documents that use dashes instead of parentheses and commas

HTML javadoc documents that were generated with javadoc tool from Java version 10 and newer use parentheses ( ) and commas , in method links/labels, for example: https://docs.oracle.com/javase/10/docs/api/java/lang/Object.html#wait(long,int). Older…
morgwai
  • 2,513
  • 4
  • 25
  • 31
4
votes
1 answer

Why mvn javadoc:fix shows success while in the same project mvn javadoc:javadoc fails afterwards?

I am trying to fix existing Javadocs into the project. I am running mvn javadoc:fix. It executes successfully BUT doesn't fix some of the Javadocs. Configuration of Maven Javadoc plugin: [DEBUG] Configuring mojo…
Dmytro Chasovskyi
  • 3,209
  • 4
  • 40
  • 82
4
votes
2 answers

maven javadoc:fix fails to autofix docs

I am migrating the MWS Feeds API project from Ant to Maven. See MWS Feeds Maven port. I get all the time the same error which makes no sense for me when executing mvn javadoc:fix. [ERROR] Failed to execute…
Dmytro Chasovskyi
  • 3,209
  • 4
  • 40
  • 82
4
votes
2 answers

Maven Release Plugin deployment of sources.jar and javadoc.jar

I use maven release plugin for generating release of my project. I do not want to generate Javadoc all time I build. On the other hand when I call release:perform I would like if maven would generate sources.jar and javadoc.jar and would deploy it…
Gábor Lipták
  • 9,646
  • 2
  • 59
  • 113
4
votes
1 answer

Javadoc warning being shown while generating the package

I'm working on the javadocs of a project, fixing all the errors and warnings that Javadoc shows.. But after fixing most of them, there are just this one that is being shown for some reason that I can't imagine. 4 warnings [WARNING] Javadoc…
Magno Nascimento
  • 615
  • 4
  • 19
4
votes
5 answers

"No public or protected classes found to document" error from path with accents

My Maven Java 8 project is inside a path which contains accents: C:\Développements\myproject. When I use maven-javadoc-plugin (event with last 2.10.4 version) I have this error when I try to generate the javadoc of my project (from IntelliJ IDEA…
Anthony O.
  • 22,041
  • 18
  • 107
  • 163
4
votes
0 answers

Javadoc ignore parameter annotation

I have functions such as public void setName(@StdString String name) { } Javadoc creates the method as it is. However I want to remove @StdString annotations from the doc created. Expected output public void setName(String name) { } I want to…
sujithvm
  • 2,351
  • 3
  • 15
  • 16
4
votes
0 answers

Javadoc linking to split package

When using the javadoc tool (Which I do through the Maven Javadoc Plugin, not with javadoc directly), there is the -link option to link to external sources. The problem now is that my project makes use of JSR-305 annotations, and I have configured…
Kelvin Chung
  • 1,327
  • 1
  • 11
  • 23
3
votes
1 answer

Difference between Maven Javadoc Plugin javadoc:jar and javadoc:aggregate-jar

I've been using the Maven Javadoc Plugin javadoc:jar goal for years, publishing many Java artifacts to Nexus (Maven Central). Currently I'm using Maven 3.8.6 with Java 17, and org.apache.maven.plugins:maven-javadoc-plugin:3.4.1. Today I'm reading…
Garret Wilson
  • 18,219
  • 30
  • 144
  • 272
3
votes
1 answer

maven-javadoc-plugin generates warning about generating every file. Why/what is it?

Having default maven-javadoc-plugin configuration: org.apache.maven.plugins maven-javadoc-plugin attach-javadocs …
Martin Mucha
  • 2,385
  • 1
  • 29
  • 49
3
votes
1 answer

How do I add additional source directories to maven to generate javadoc?

I used this in my pom.xml to recognize the second source directory I have in my project: org.codehaus.mojo build-helper-maven-plugin …
tripleo
  • 31
  • 3
3
votes
0 answers

Having trouble with maven-javadoc-plugin aggregation

I have a Maven aggregate project with three child modules, so the project is like so: Parent | |- ChildA |- ChildB |- ChildC The classes use aggregation and inheritence: Parent lists the children as modules, and each Child specifies Parent…
Doug
  • 31
  • 2
3
votes
0 answers

Error during generation of javadoc with aggregate - unable to write temporary file - can't generate javadoc

My project has several modules and it is written in Java 8, I am using jdk 11 to build. When I try to generate JavaDocs by using mvn javadoc:aggregate I fail with this error: > Failed to execute goal >…
rbednarska
  • 129
  • 1
  • 2
  • 13
3
votes
0 answers

maven javadoc shows annotation twice

I am trying to add JetBrains Annotations library to my code. Now I come across, that if I generate JavaDoc of my code the appearance of them is duplicated. Once is without qualifier (the annotations are imported, so no one is needed) and the second…
rala
  • 895
  • 2
  • 18
  • 43
1 2 3
…
14 15