当前位置: 首页 > 知识库问答 >
问题:

使用Maven Javadoc插件,我可以只为特定的包创建Javadoc吗?

程祺
2023-03-14

使用Maven JavaDoc插件,我可以只为特定的包创建JavaDoc吗?我有一个父模块,只想为子模块中选定的包生成Javadoc。例如

Parent
|
|__Module1
|____Package1
|____Package2
|
|__Module2
|____Package3
|____Package4

我希望Javadocs只适用于Module1下的Package2

共有1个答案

叶举
2023-03-14

在父文件中定义javadoc插件。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.0.0-M1</version>
    <configuration>
        <skip>true</skip>
    </configuration>
</plugin>

因此,javadoc生成是可用的,但默认情况下会被跳过。

在模块1中,用skip和sourceFileIncludes声明插件。例如:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <configuration>
        <skip>false</skip>
        <sourceFileIncludes>
            <exclude>Package2/*.java</exclude>
        </sourceFileIncludes>
    </configuration>
</plugin>

这为module1启用javadoc生成,但仅针对Package2中的类。

这通过Maven Javadoc插件的v3.0.0-M1进行了验证。

 类似资料:
  • 问题内容: 我由大约40个开发人员组成的团队工作,我不希望任何开发人员使用任何开发人员都可以使用的特定API(准确地说是java.sun.Base64),而是让他们使用sun API的替代方法作为其专有。 是否有用于maven的插件,通过这些插件在pom.xml中指定受限制的软件包,如果在代码中的任何位置使用了这些软件包中的任何一个,则构建将中断? 还是有一种更优雅的方式来做到这一点? 谢谢 问题

  • Javadoc工具有一个名为“packagename”的命令行选项,允许您指定要记录的包名称。maven javadoc插件支持这个论点吗? 似乎maven支持所有选项作为配置属性,但Packagename不是一个选项,它是一个命令行参数,我看不到它在maven javadoc插件页面上列出。 maven插件确实支持subpackages选项,但这是不同的(它是递归的,而packagenames参

  • 我目前正在尝试将我以前的“GUI”构建步骤转换为管道groovy脚本。我以前从valgrind插件中获得了一个步骤来发布valgrind运行的结果。 我在管道语法片段生成器中找到了“步骤:通用构建步骤”函数,并试图使用它来创建使用以下代码的valgrind发布结果步骤: 当我运行这个詹金斯抱怨: 所以我不确定问题是否是ValgrindPublisher只派生自BuildStep而不是SimpleB

  • 该插件在toolsmenu中或菜单中任何位置只包含一个操作,但我总是得到空java.lang.NullPointerException即使它是空操作android studio 2.3.3空project intellij idea 2017.1.5我尝试了Community和ultimate两个版本

  • 我正在为Eclipse3.7.2版本的equinox开发一些插件。不幸的是,我无法升级到最新的equinox平台。所提供的equinox平台在其清单中没有提供“require-capability:osgi.ee;filter=”(&(osgi.ee=javase)(version=1.8))“条目。所以我不能在我的插件中使用”bundle-requiredexecutionEnvironment

  • 问题内容: 在我看来,这似乎是最容易找到的东西,这是一种在eclipse中将我的类显示为UML的简单方法 但是,除了以下内容:http : //java2uml.gforge.enseeiht.fr/和此http://sourceforge.jp/projects/amateras/releases/我没有找到任何新的,维护的和“良好”的实现(都应有关于以上两个) 还有什么我想念的吗? 问题答案: