Maven的{Do气风格主页

时间:2016-06-23 01:46:57

标签: java maven doxygen

我们有一个OSX的API,我们提供3种不同的语言; Objective-C,C ++和Java。

对于C ++和Objective C语言,我们使用Doxygen来获取所有文档。同样为示例页面(mainpage.h)提供了应用于类页面的漂亮外观。我特别喜欢语法着色。

对于Java语言,我们使用的是Maven。由于apple的开发环境并不能为Java提供太多功能,因此我们可以将Maven用于文档及其体面的构建系统。在我看来,类页面看起来和Doxygen一样好,但是主要示例页面(examples.apt)的呈现看起来非常简单明了。

我一直在搜索有关如何为页面添加颜色的任何参考,但还没找到任何颜色。

我的问题:

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

1 个答案:

答案 0 :(得分:2)

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

请参阅https://github.com/BradleyRoss/tutorials了解我如何设置一些Javadoc设置。查看父模块中的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版本,以获得有关可以更改的内容的一些想法。

相关问题