问题描述
我目前正在编写1个模块中包含的JavaFX应用程序,并且我想使用Javadoc记录所有代码。但是,我注意到我似乎无法为尚未从module-info.java
中的模块导出的软件包生成Javadocs。一方面,这是有道理的。未导出的软件包不属于公共API。另一方面,我觉得肯定应该有一些选项可以启用隐藏在未导出程序包中的内部API的文档,但是启用它们并没有成功。
因为这是一个Maven项目,所以我尝试使用maven-javadoc-plugin进行以下选择:
-
<show>private</show>
-
<additionalOptions>-private</additionalOptions>
-
<additionalOptions>--show-module-contents all --show-packages all --show-types private</additionalOptions>
这些工作都没有(我很确定1和2是完全一样的)。他们只显示了我已导出到另一个特定模块的一个软件包的更多信息。如果没有这些选项,则Javadoc的“模块”部分将完全空白,但模块名称除外。
我已经做了很多谷歌搜索,互联网上似乎没有人提出这个问题。也许我的Google-Fu即将关闭?我觉得好像还没有找到一个愚蠢的未记录的标志,因为不可能必须导出软件包来获取Javadocs,对吧?
我的项目仅包含一个包含8个程序包的模块。它们都不需要完全导出。只需将包含我的JavaFX文件的一个程序包导出到javafx.graphics
,这就是我启用<show>private</show>
时Javadoc拾取的唯一程序包。
如果有人需要,这里是我的模块和Maven配置的要点: https://gist.github.com/urbenlegend/753de7bec598fd07d6b5c0b0ef02d1d0
我正在通过mvn compile javadoc:javadoc
调用Javadoc生成
这里有任何提示吗?预先感谢!
解决方法
暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!
如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。
小编邮箱:dio#foxmail.com (将#修改为@)