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

maven-javadoc-plugin failure due to StringIndexOutOfBoundsException

I always got StringIndexOutOfBoundsException issue when running mvn javadoc:javadoc. Anyone know about this error? Below is the full stack trace: [INFO] Scanning for projects... [INFO] [INFO]…
Gelin Luo
  • 14,035
  • 27
  • 86
  • 139
1
vote
1 answer

Maven JavaDoc Plugin by providing Source path

org.apache.maven.plugins maven-javadoc-plugin 2.9.1 ${svn url}/src/main/java …
swamy
  • 1,200
  • 10
  • 23
1
vote
1 answer

Using both aggregate and jar goals for javadoc

I would like to generate javadoc for my whole project using the aggregate goal but I would also like to generate javadoc jars for several sub-projects. In my parent pom.xml I added the following pluginManagement to allow sub-projects to generate…
myshkin5
  • 31
  • 3
1
vote
1 answer

How to specify packagenames with the Maven Javadoc plugin

The Javadoc tool has a command-line option called "packagenames" which allows you to specify the package names you want to document. Does the maven javadoc plugin support this argument? It seems that maven supports all the options as configuration…
Fletch
  • 4,829
  • 2
  • 41
  • 55
1
vote
1 answer

Maven Javadoc Plugin During Site Goal: javadoc: error - java.lang.OutOfMemoryError: Please increase memory

I have been struggling to increase the memory of my javadoc plugin via my pom file. For some reason my Mac build slave fails during the site goal with an OutOfMemoryError. I tried adjusting the maxmemory of the javadoc plugin via my…
Dan
  • 1,955
  • 17
  • 21
1
vote
2 answers

How can I compile and run my Custom Doclet class in my project?

I'm trying to dump all class javadoc comment (preferabbly subclasses of a libraries WebPage class) at compile time into a .properties file in the format classname=comment. So far I have: created doclet class SiteMapDoclet the class is defined to…
Raystorm
  • 6,180
  • 4
  • 35
  • 62
1
vote
0 answers

Linked javadocs across multiple code repos

I have a application whose various components are spread across about 100 git repos. They are all standalone maven projects (they have dependencies among themselves, of course), and I create a .war by bundling all of them for the application. I want…
Aman
  • 639
  • 1
  • 9
  • 25
1
vote
1 answer

Java docs that include classes based on inheritance

Note that I have written "Java docs", as I'm not necessarily expecting the javadoc utility to acheive what I'm after (let alone the maven-javadoc-plugin I'm using). I need to produce a doc site that includes only classes that extends/implements a…
RCross
  • 4,919
  • 4
  • 44
  • 42
1
vote
1 answer

Generate javadoc in maven and then upload via scp?

I have Maven javadoc plugin working nicely right now, but I do not know how to add it to the remote directory via scp. How do I transfer the javadoc files via scp, but AFTER they have been generated? Can this automatically happen when I call…
Sam Levin
  • 3,326
  • 7
  • 30
  • 44
0
votes
1 answer

Maven build error wile building the sub modules in a project

Below are the errors we are encountering after the maven build in a project: Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.0:compile (default-compile) on project test1: Compilation failure: Compilation failure & Failed to…
Soumya
  • 27
  • 3
0
votes
0 answers

maven-site-plugin to skip Generating "Test Javadoc" report --- maven-javadoc-plugin

What I am trying to achieve: Generate project website from maven site plugin, without the javadoc for tests (but with javadoc for the classes) What did I try: …
PatPanda
  • 3,644
  • 9
  • 58
  • 154
0
votes
0 answers

An error has occurred in Javadoc report generation While running a command "mvn -Pfitnesselocal test"

This is my error log [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.4.1:javadoc (default) on project WorkFlow: An error has occurred in Javadoc report generation: [ERROR] Exit code: 1 - error: Class…
revinard moses
  • 1
0
votes
0 answers

How can we include JavaDocs in a JavaModule deployment?

When deploying a Java module, what should be in the POM so that the dependencies can utilize it to generate HTML documentation? I want to utilize the maven-javadoc-plugin to generate html documentation from a dependency and include the documentation…
taetaetae
  • 141
  • 1
  • 6
0
votes
2 answers

Creation of Java jar library in Intellij which includes Quickdock (doc that is shown when pressing ctrl+Q)

I want to export my code in a jar so I can reuse it in other projects. The question here is how to include the java-doc i wrote in the code in a way that it is displayed in the project where I use the jar file when displaying Quick documentation…
mad_mosel
  • 35
  • 8
0
votes
1 answer

Oracle javadoc links not working with maven javadoc plugin for java 11

Generated javadocs using maven plugin with config org.apache.maven.plugins maven-javadoc-plugin 3.4.1 11 …
Abhishek Surve
  • 17
  • 5
1 2 3
…
14 15