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

maven javadoc plugin error when used with modules Exit code: 1 - error: module not found:

I have a multi-module project that uses maven as its build system. I want to generate javadocs for the project. I do: mvn -e javadoc:javadoc When maven gets to the first module (Util) I get this: Exit code: 1 - error: module not found:…
munki
  • 41
  • 5
3
votes
1 answer

Maven multi-module project site with javadocs

I would like use Maven for creating site for my application. This is a multi-module app, the parent module is simple site module, and first child is a core of app, the second is a GUI (Swing). I now use follow for parent pom.xml …
Gabor Garami
  • 1,245
  • 8
  • 26
3
votes
1 answer

SonarQube not showing errors in javadoc

I have a project in spring-boot java and on doing the sonarqube analysis of the code, javadoc errors are not detected. The issue occurs during maven release when there is an error in javadoc the release build fails to build the javadoc jars and the…
Jerrin Thomas
  • 269
  • 3
  • 14
3
votes
1 answer

Binding Javadoc generation to mvn package

I'm new to Maven (first university assignment), and I'm trying to find help wherever I can. I'm supposed to configure Maven in order for it to compile, create a JAR file, and generate javadoc when using the mvn package command. I've tried adding…
olirwin
  • 545
  • 5
  • 21
3
votes
1 answer

Create JavaDoc on GitLab by every Push

I'm working on a Java project, which runs on GitLab. I'm trying to find a way, in which GitLab automatically generates the Java documentation on each push. I tried to use the JavaDoc plugin for Maven and call it with a pipeline. But the plugin needs…
CodeMaster3000
  • 51
  • 3
3
votes
1 answer

Maven javadoc plugin 3.1.0 not generating aggregate javadocs

I have a multi-module project for which I'd like to generate aggregate javadoc reports. I am using maven-javadoc-plugin version 3.1.0. Here's the reporting section of pom.xml file: …
srikanta
  • 2,914
  • 3
  • 21
  • 35
3
votes
2 answers

Generate Javadocs for easy consumption on mobile phones

I generated some javadocs, looks pretty good, I can even include inline code samples/examples. However, doesn't look very good on mobile: Here are the plugin settings I am using: …
user5047085
3
votes
1 answer

Add example usage (markdown?) to JavaDocs

Say I have this: Is there a way to add markdown or html to each method, with an example of how to use the method? I am thinking an expanding panel - button says view example and it opens a panel. I tried adding this to the inline docs: /** *…
Alexander Mills
  • 90,741
  • 139
  • 482
  • 817
3
votes
1 answer

Maven JavaDoc plugin giving warnings instead of Errors

i have added maven java doc plugin dependency in my pox.xml as below org.apache.maven.plugins maven-javadoc-plugin 3.0.0 …
Kavitha Yeleti
  • 51
  • 1
  • 4
3
votes
1 answer

What causes maven-javadoc-plugin goal test-javadoc to fail on errors but test-javadoc-no-fork just to have warnings

I have a Maven project with maven-javadoc-plugin and JDK8. When I run mvn javadoc:test-javadoc then the plugin reports documentation-errors and stops, but when I run mvn javadoc:test-javadoc-no-fork the plugin runs successful and there's just some…
Ralph
  • 118,862
  • 56
  • 287
  • 383
3
votes
4 answers

Maven searches for missing english locale of site.xml

During building a project with maven, I run into an issue generating javadoc after updating the version of its parent project. 2016-08-18 16:06:44.559 [INFO] <<< maven-javadoc-plugin:2.10.3:aggregate < generate-sources @ org.eclipse.scout.rt…
Patrick
  • 4,720
  • 4
  • 41
  • 71
3
votes
3 answers

How to exclude a single module from Javadoc generation in a Maven multi module project?

I have a Maven multi module project like this: foo-parent foo-module foo-module-new foo-other-module1 foo-other-module2 pom.xml And when calling mvn javadoc:aggregate in foo-parent, I want to exclude the module foo-module from…
Arend v. Reinersdorff
  • 4,110
  • 2
  • 36
  • 40
3
votes
1 answer

Javadoc private methods

I've developed my own Doclet to generate csv from Java classes. I need to launch this Doclet about many projects and I can't edit POM files. So I'm running using terminal: mvn…
IvanMoreno
  • 145
  • 10
3
votes
1 answer

Is there a workaround for maven-javadoc-plugin bug MJAVADOC-414?

While using maven-javadoc-plugin to generate test Javadoc I suddenly got multiple errors stating that the Javadoc plugin was unable to find any classes from my main codebase. While running the test-javadoc goal the classpath contained only classes…
Emily Mabrey
  • 1,528
  • 1
  • 12
  • 29
3
votes
1 answer

Maven javadoc + custom doclet

How can i specify the doclect artifact when calling mvn from command line mvn clean install javadoc:javadoc -Ddoclet=my.Doclet -DdocletArtifact=????
Christian Dietrich
  • 11,778
  • 4
  • 24
  • 32
1 2 3
…
14 15