由 Maven 构建

在 Java 中使用 Maven JXR

交叉引用 API 非常基础。您可以为给定的 Java 包或单个 Java 源类生成外部参照。整个生成的文件按行号进行外部参照。

转换 Java 包

JXR 处理几个选项，例如输入/输出编码。有关更多信息，请参阅API。

JXR jxr = new JXR();
jxr.setDest( "/target/jxr" );
jxr.setLog( new DummyLog() );

jxr.xref( Collections.singletonList( "/src/main/java/" ), "templateDir",
                                     "WindowsTitle", "DocTitle", "Bottom" );

注意：templateDir是一个包含多个Velocity模板的目录。Maven JXR 使用它自己的模板。

生成的 JXR 结构应如下所示：

/target/jxr
 |- allclasses-frame.html
 |- index.html
 |- overview-frame.html
 |- overview-summary.html
 ...

转换单个 Java 源文件

您可以使用以下内容转换单个 Java 源文件：

File sourceFile = new File( "/src/main/java/Test.java" );

PackageManager packageManager = new PackageManager( new DummyLog(),
                                                    new FileManager() );
JavaCodeTransform codeTransform = new JavaCodeTransform( packageManager );

codeTransform.transform( sourceFile.getAbsolutePath(), "/target/jxr/Test.html",
                         Locale.ENGLISH, "ISO-8859-1", "ISO-8859-1", "", "" );