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
0 answers

How can I override properties for test-aggregate-no-fork?

I configured different version for main and test. 8 ${maven.compiler.source}
Jin Kwon
  • 20,295
  • 14
  • 115
  • 184
0
votes
1 answer

VScode maven not executing plugins

I am trying to get my library uploaded to the maven central repository using VScode. In order to meet the requierments for that, I have a bunch of plugins configured in my pom.xml file. Here are all the plugins:
0
votes
1 answer

Aggregate javadoc by packages

Say I have the following package structure: When I generate the javadoc, I will get the following under index.html: I find that inconvenient for two reasons: You can't really explore the classes by package, since all the list is flat (it's not…
Matteo NNZ
  • 11,930
  • 12
  • 52
  • 89
0
votes
1 answer

Javadoc for JPMS modules when module name is different from artifactId

I have a sample project with two jpms modules. It is a maven project with one parent and two child modules. A parent pom: ... foo.api foo.impl ... API module…
Pavel_K
  • 10,748
  • 13
  • 73
  • 186
0
votes
1 answer

Avoid staging and deploying Javadoc for individual modules in multi-module Maven project

I have a multi-module Maven project. I have set up the parent POM to generate aggregated Javadoc, like ... org.apache.maven.plugins
Karsten Spang
  • 161
  • 2
  • 10
0
votes
1 answer

Unable to generate javadocs using frame with maven-javadoc-plugin

I am using the default configuration of maven-javadoc-plugin 3.2.0 I would like to generate something like the the testapidocs, but unfortunately it generates only NOFRAMES doc. I tried playing a little bit with no success. Anyone else having the…
Sixro
  • 402
  • 4
  • 16
0
votes
1 answer

Windows10 cmd.exe default directory different to Windows7

I am seeing a difference in behaviour on the default directory when you execute cmd.exe when you are already inside a shell between Win7 and Win10. Windows 7: C:\projects\test>ver Microsoft Windows [Version 6.1.7601] …
jmsjr
  • 148
  • 2
  • 10
0
votes
0 answers

Is it possible to inherit javadoc from another class/method without type inheritance?

Say I have a bunch of annotations under the same domain where some properties of them are common. @Color @interface Black { /** * The density of the color in range 0-255. If a non valid value is given, an * exception will be thrown. …
George Z.
  • 6,643
  • 4
  • 27
  • 47
0
votes
2 answers

Cannot run javadoc from console at java 10

I'm trying to get javadocs for my classes directly from console with following code javadoc -sourcepath ./src/main java.packageName. Those classes have dependencies on external libraries (e.g junit.framework). This code is easy to compile from…
Eugen
  • 165
  • 1
  • 1
  • 10
0
votes
1 answer

Exclude jquery from maven-javadoc-plugin

Trying to generate javadoc without jquery using "maven-javadoc-plugin", where as it will include jquery if the source is compiled with JDK 11 and above, where as if the same is compiled with JDK 8 then it won't. Tried adding "doclint" (none) and…
gprasad
  • 16
  • 2
0
votes
1 answer

Change default copyright notice in Javadoc page footer

I am generating Javadoc pages for my project using the Maven Javadoc plugin, with mostly default settings. I have noticed that each generated page has the following footer text: Copyright © 2020. All rights reserved. How can I change this text to…
user149408
  • 5,385
  • 4
  • 33
  • 69
0
votes
0 answers

Is there any way to combine main jar and source jar in a single jar

I created a common jar with below dependency - org.apache.maven.plugins maven-source-plugin
Suman
  • 131
  • 1
  • 2
  • 7
0
votes
0 answers

Javadoc is coming for class but not coming for methods

I implement javadoc generation in my project and able to make jar for that project by this following - org.apache.maven.plugins maven-javadoc-plugin
Suman
  • 131
  • 1
  • 2
  • 7
0
votes
1 answer

How to write javadoc @deprecated method with parameters @link

/** * @deprecated As of release 4.1, replaced by {@link com.github.noraui.application.steps.WaitSteps#waitVisibilityOf(String, List)} * * */ @Deprecated public void checkElementVisible(String pageElement,…
Stéphane GRILLON
  • 11,140
  • 10
  • 85
  • 154
0
votes
0 answers

maven-javadoc-plugin fails on jdk 11 when compiling for jdk 8

I have a maven-wise simple project targeting Java 1.8 here. mvn javadoc:javadoc runs fine on OpenJDK 8, but fails on OpenJDK 11 with this error message: javadoc: error - The code being documented uses modules but the packages defined in…
rü-
  • 2,129
  • 17
  • 37