为不存在的类生成Javadoc

时间:2016-04-13 09:15:31

标签: javadoc maven-javadoc-plugin

该项目由一个具有多个模块的根pom.xml组成。 根软件包com.example根本不包含任何代码(无src目录)。每个模块都包含一个包,带有子包,采用典型的maven结构:com.example.foocom.example.barcom.example.bar.baz等。

我的根pom.xml中有groups configuration

我使用命令mvn clean javadoc:aggregate制作javadoc。

生成的javadocs按预期对包进行分组,但有一个例外:我还在组其他包中获取根包com.example的javadocs,并且它包含一个类{{ {1}},评论为App。但是,这个Hello world!不存在,事实上,在App的整个代码库中点击会导致零结果。

如何避免生成不存在的类的文档?

已经尝试过:

  • Hello world! - >这导致根本没有生成javadoc,因为它也排除了子包。

1 个答案:

答案 0 :(得分:0)

回答我自己的问题。

<subpackages>com.example.foo:com.example.bar:com.example....<subpackages>添加到配置中,并省略根软件包com.example

这可以按预期工作,但缺点是重复配置。

我仍然欢迎任何解释为什么以及如何生成App javadoc的答案,出于好奇心。