JavaDoc提供完全限定的类名...如何缩写?

时间:2013-01-12 23:07:26

标签: java javadoc maven-javadoc-plugin

问题

我正在运行mvn javadoc:javadoc来生成JavaDoc,我对结果感到满意,除了一件事:它为来自第三方库或我们自己的代码库的任何类提供了完全限定的类名。例如,

它为返回其中一个类的方法提供了返回类型 com.project.beans.BeanA com.project.beans.BeanB

它为采用JSON对象的方法提供了 org.codehaus.jettison.json.JSONObject 的参数类型。 (它为一个带有java.lang.Integer的方法提供了一个param类型的Integer。)

问题

出于可读性目的,有没有办法为这些类生成速记名称?即BeanA,BeanB,JSONObject。

有没有办法在没有任何XML配置的情况下执行此操作?

提前致谢: - )

1 个答案:

答案 0 :(得分:8)

我相信你想要的是-noqualifier javadoc option,它可以直接从maven javadoc:javadoc命令设置。

通常将参数传递给maven插件,你只需要使用-D来处理其他Java程序,在这种情况下它将是mvn -Dnoqualifier=all javadoc:javadoc,但据我所知noqualifier似乎没有设置为插件源中的表达式,所以我真的不知道你是否可以通过命令行传递它。

如果它不起作用,您可以修改pom.xml并将<noqualifier>all</noqualifier>添加到javadoc插件的配置中。或者您可以在pom中创建一个属性,该属性将作为<noqualifier>标记的值给出,但这次可以使用命令行覆盖该属性。