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

maven 3 javadoc plugin ignores configuration

I use maven 3 and have my javadoc configured according to the new maven 3 siteplugin+javadoc configuration. However all of my javadoc configuration parameters seem to be ignored. So no package grouping, no source linking etc. My project is a multi…
Zubzub
  • 782
  • 7
  • 18
6
votes
2 answers

maven-javadoc-plugin error javadoc: error - cannot read Input length = 1 with non-ASCII characters in directory name

I'm using OpenJDK 11 on Windows 10. I have a very simple POM, for a single Java file, that generates Javadocs. Here is an extract: UTF-8 …
Garret Wilson
  • 18,219
  • 30
  • 144
  • 272
6
votes
2 answers

Execution attach-javadocs of goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.0:jar failed with Java10

Following the link Upgrade to Java 10 breaks links in Javadoc comments to JDK packages and trying to reproduce the same while I could set the build configuration to : …
Naman
  • 27,789
  • 26
  • 218
  • 353
6
votes
1 answer

Maven Javadoc aggregate-jar plugin fails because of unresolved dependencies

I have multi-module Maven project in which I run the maven-javadoc-plugin to generate javadoc. In my parent pom.xml I have defined the plugin build as follows: org.apache.maven.plugins …
qtips
  • 625
  • 6
  • 17
6
votes
1 answer

JavaDoc giving fully-qualified class name... how to abbreviate?

Problem I'm running mvn javadoc:javadoc to generate JavaDoc, and I am pleased with the results, except for one thing: it gives the fully qualified class names for any class coming from a third-party library or our own codebase. For example, It gives…
ktm5124
  • 11,861
  • 21
  • 74
  • 119
6
votes
1 answer

Generating multiple javadoc reports using maven-javadoc-plugin and Maven 3

We use a custom doclet to generate a report from custom javadoc tags, and use the Maven site plugin and javadoc plugin to generate both this report and the regular java API docs. The section of the POM looks like this: …
Richard
  • 143
  • 1
  • 10
5
votes
1 answer

JavaDoc with Maven generates 'Error fetching link:'

Generating a JavaDoc with Maven I get an error message 'Error fetching link:' referring to a file javadoc-bundle-options. In it it contains javadocResourcesDirectory with a directory. Even if I create that directory I still get the same error. How…
B. Stackhouse
  • 477
  • 5
  • 15
5
votes
1 answer

Maven 3: Generate Javadoc for defined artifacts

I want to generate javadocs only for certain artifacts of my project from within a dedicated docs-project. That means that I would like to have an independent project called "docs" for example. In the docs/pom.xml I would like to define the…
Jens
  • 20,533
  • 11
  • 60
  • 86
5
votes
2 answers

maven-javadoc-plugin sourceFileExcludes not working

I'm not too sure what is the right way to use this tag, but I use it like this: It doesn't work at all. It seems that there was a known bug in maven that this…
pythonician_plus_plus
  • 1,244
  • 3
  • 15
  • 38
5
votes
1 answer

maven-javadoc-plugin overwrites central repository

I have a problem with the Maven Javadoc Plugin and a custom doclet. I'm using the maven-javadoc-plugin v2.10.1 and a custom doclet which is basicly a maven jar project. I have also a settings.xml which defines the central repository to a custom…
Maxx
  • 81
  • 1
  • 9
5
votes
1 answer

How to use AsciiDoclet to generate asciidoc file from javadoc comments in .java file

I'm newbie with asciidoc. I want to generate HTML Documentation from commented javadoc (in asciidoc format) in java file. for example java file /** * = Asciidoclet * * Sample comments that include `source code`. * * [source,java] * -- *…
Piyush
  • 1,528
  • 2
  • 24
  • 39
5
votes
1 answer

Why does Maven use the wrong plugin despite explicit plugin and pluginManagement version?

My parent pom exlicitly declares a dependence on maven-javadoc-plugin 2.9.1 in both org.apache.maven.plugins maven-javadoc-plugin …
djb
  • 4,930
  • 1
  • 34
  • 37
5
votes
0 answers

Proper generation of javadocs links to external libraries

I have developed a Java library that makes use of some other libraries also developed by me. All of them published online and managed with Maven. My problem concerns proper inclusion of links in the generated Javadocs. For example, if a class in my…
Sergio
  • 8,532
  • 11
  • 52
  • 94
5
votes
1 answer

Automatic verification of JavaDoc with Maven

During refactoring it happens frequently that JavaDoc gets out-of-date. It describes method arguments which are not present any more or some new ones are missing, to give examples. It would be fine, if there is a Maven-plugin which automatically…
MrD
  • 1,255
  • 1
  • 10
  • 24
4
votes
1 answer

How to link source classes JavaDoc from Test JavaDoc in maven site?

Having configured maven-site-plugin and maven-javadoc-plugin (with doclava doclet), I'm trying to get proper JavaDocs on the site generated by mvn site. In my code I have sevaral JUnit test classes (located in src/test/java/my/package/*.java) which…
Evgeny A.
  • 731
  • 2
  • 8
  • 19
1 2
3
…
14 15