如何为多个模块生成javadoc

Question

我正在尝试为单个文档中的多个模块创建 javadoc (jdk11)。

我尝试这样做。

文件/目录结构为：

workspace
    doc
    maths
        src
            main
                java
                    net.virtualpsyclab.maths
                        net
                            virtualpsyclab
                                maths
                                    lib
                                        *.java
                    module-info.java
    genutils
        src
            main
                java
                    net.virtualpsyclab.genutilsm
                        net
                            virtualpsyclab
                                genutilsm
                                    *.java
                    module-info.java
module-info.java
jdocOptions.txt
files.lst

jdocOptions.txt 包含：

-d doc
--module-source-path .;genutils\src\main\java\net.virtualpsyclab.genutilsm;maths\src\main\java\net.virtualpsyclab.maths
--module workspace,net.virtualpsyclab.genutilsm,net.virtualpsyclab.maths
-verbose
-overview overview.html

files.lst 列出所有 *.java 文件。

三个 module-info.java 文件包含：

workspace\module-info.java
module workspace{
    requires net.virtualpsyclab.genutilsm;
    requires net.virtualpsyclab.maths;
}

workspace\genutils\src\main\java\net.virtualpsyclab.genutilsm\module-info.java
module net.virtualpsyclab.genutilsm{
    exports net.virtualpsyclab.genutilsm;
}

workspace\maths\src\main\java\net.virtualpsyclab.maths\module-info.java
module net.virtualpsyclab.maths{
    exports net.virtualpsyclab.maths.lib;
}

我希望模块 net.virtualpsyclab.genutilsm 和 net.virtualpsyclab.maths 的文档出现在目录workspace\doc 中，然后运行命令：

javadoc @jdocOptions.txt @files.lst 

从目录工作区中，我看到所有源文件显然正在处理，例如：

Loading source file c:\Users\Admin\workspace\maths\src\main\java\net.virtualpsyclab.maths\net\virtualpsyclab\maths\lib\NDieDistribution.java...
[parsing started SimpleFileObject[C:\Users\Admin\workspace\maths\src\main\java\net.virtualpsyclab.maths\net\virtualpsyclab\maths\lib\NDieDistribution.java]]
[parsing completed 0ms]

但随后一切都以“javadoc：错误 - 未找到模块工作区”结束。

非常感谢对我在这里出错的任何帮助。

Answer 1

根据这个问题和这里的信息，我现在已经弄清楚了如何做到这一点。这些链接解释了各种 java 工具的多模块操作模式。多模块模式是通过包含选项 --module-source-path 来触发的。module-source-path 的元素是包含模块定义的目录。模块定义可以是模块名称对应的包含 module-info.java 的目录以及包和源文件对应的目录结构。这样我就放弃了聚合器模块的想法（从上面的工作区目录中删除 module-info.java ）并将 jdocOptions.txt 文件更改为如下所示：

-d doc
--module-source-path genutils\src\main\java\;maths\src\main\java\

关键的更改是删除在单模块模式下用于识别根模块的 --module 选项，并缩短 --module-source-path 选项中的路径，以便模块目录（例如 net.virtualpsyclab.maths）是子模块- 路径的目录而不是路径的一部分。

现在我在工作区/doc 中有我的两个模块所需的文档！