springboot集成javadoc插件实现文档聚合

最新推荐文章于 2024-08-08 07:12:07 发布

我是匿名用户

最新推荐文章于 2024-08-08 07:12:07 发布

阅读量1k

点赞数

文章标签： spring boot intellij-idea java

本文链接：https://blog.csdn.net/qq_40104261/article/details/122425364

版权

包结构

|- com.test:parent
| ----- com.test:A
| ----- com.test:B
| ----- com.test.C

依赖关系

C依赖A和B

实现效果

想让C的文档中包含A的内容

plugin插件配置

该内容仅在parent项目的pom下配置即可

            <!-- 生成javadoc文档包的插件 -->
            <plugin>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                    <charset>UTF-8</charset>
                    <docencoding>UTF-8</docencoding>
                </configuration>
                <executions>
                    <execution>
                        <id>javadoc-jar</id>
                        <phase>package</phase>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                        <configuration>
                            <!-- 不会因为报错退出 -->
                            <failOnError>false</failOnError>
                            <doclint>none</doclint>
                            <!-- switch on dependency-driven aggregation -->
                            <includeDependencySources>true</includeDependencySources>

                            <dependencySourceIncludes>
                                <!-- 仅包含我控制的依赖项  此处说明的是包名-->
                                <dependencySourceInclude>com.test:A:*</dependencySourceInclude>

                            </dependencySourceIncludes>

                        </configuration>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-source-plugin</artifactId>
                <version>2.1.1</version>
                <executions>
                    <execution>
                        <id>bundle-sources</id>
                        <phase>package</phase>
                        <goals>
                            <!-- produce source artifact for main project sources -->
                            <goal>jar-no-fork</goal>

                            <!-- 包含test相关文档,放开这部分文档 -->
                            <!-- <goal>test-jar-no-fork</goal>-->
                        </goals>
                    </execution>
                </executions>
            </plugin>