Maven 的 Doxygen 风格主页

Doxygen style mainpage for Maven

我们有 API for OSX,我们提供 3 种不同的语言; Objective-C、C++ 和 Java.

对于 C++ 和 Objective C 语言,我们在所有文档中使用 Doxygen。示例页面 (mainpage.h) 也提供了适用于 class 页面的同样漂亮的演示文稿。我特别喜欢语法着色。

对于 Java 语言,我们使用 Maven。由于 apple 的开发环境并没有真正为 Java 提供多少,我们可以将 Maven 用于文档及其一个不错的构建系统。在我看来,class 页面看起来和 Doxygen 一样好,但是主要示例页面 (examples.apt) 的介绍看起来非常平淡无奇。

我一直在寻找有关如何向页面添加颜色的任何参考,但还没有真正找到任何东西。

我的问题:

任何人都可以提供如何在适当的 .apt 文件 (examples.apt) 或 sites.xml 文件中实现着色的示例吗?

有两个主要位置可用于自定义 Javadoc。 pom.xml 文件中的第一个。第二个位置在 src/main/javadoc 目录中。您可能必须自己创建 src/main/javadoc 目录,因为它通常不在初始目录集中。

有关我如何设置一些 Javadoc 设置的信息,请参阅 https://github.com/BradleyRoss/tutorials。查看父模块中的 pom.xml 和 tutorials-common 模块中的 src/main/javadoc 目录。

有关如何用您自己的文件替换 stylesheet.css 文件的信息,请参阅 https://maven.apache.org/plugins/maven-javadoc-plugin/examples/stylesheet-configuration.html。这可能是大多数颜色选择的地方。它在 Javadoc 插件的配置部分使用 stylesheetfile 和 stylesheet 标签。

Maven 显然使用了 JDK 附带的 stylesheet.css 文件的修改版本。您可能想要比较 JDK 和 Maven 版本,以了解您可以更改的内容。