I'm using the maven-javadoc-plugin, how can I include documentation from other modules together?

Question

I have two modules, A and B, and A depends on B. They are completely separate, and B is deployed and used in an internal repository.

You want to use the maven-javadoc-plugin for documentation in A, but you also want to include the contents of B's dependent modules. For example, you might have something like this

RespostDTO testMethod(int a) { // blabla }

Assuming we have the above method in A's module, RespostDTO is B's module code. In this case, we want to see the JavaDoc corresponding to RespostDTO in the documentation created in A. How can we do this?

What should I do for A and B modules?

ursa · Accepted Answer · 2023-03-16 10:34:41Z

2

You can explicitly add dependencies into javadoc generation:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <sourcepath>${basedir}/src/main/java</sourcepath>
        <includeDependencySources>true</includeDependencySources>
        <dependencySourceIncludes>
            <dependencySourceInclude>some.group.id1:*</dependencySourceInclude>
            <dependencySourceInclude>some.group.id2:artifactId2</dependencySourceInclude>
        </dependencySourceIncludes>
    </configuration>
</plugin>

Source: https://maven.apache.org/plugins/maven-javadoc-plugin/examples/aggregate-dependency-sources.html#fine-tuning-included-dependencies

answered Mar 16, 2023 at 10:34

ursa

4,7011 gold badge29 silver badges39 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

taetaetae Over a year ago

Thanks for the advice. In the module you gave as an example (some.group.id2:artifactId2), what should we do?

ursa Over a year ago

this is just a reference to the dependency you want to see in generated docs. in your case it's module B.

taetaetae Over a year ago

I've posted a separate question in stackoverflow.com/questions/75758892/… , but I'm also curious about the pom configuration for module B. What should be the configuration for module B?

Collectives™ on Stack Overflow

I'm using the maven-javadoc-plugin, how can I include documentation from other modules together?

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related