2016-06-23 30 views
0

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

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

对于Java语言,我们使用的是Maven。由于苹果的开发环境并没有真正为Java提供太多的东西,所以我们可以将Maven用于文档及其体面的构建系统。在我看来,课堂页面看起来和Doxygen一样好,但主要示例页面(examples.apt)的介绍看起来很简单并且很平稳。

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

我的问题:

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

+0

真的被卡住了.apt?为什么不使用降价?此外,您正在使用哪些网站皮肤? – khmarbaise

回答

2

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

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

https://maven.apache.org/plugins/maven-javadoc-plugin/examples/stylesheet-configuration.html关于如何用自己的替换stylesheet.css中的文件信息。这可能是大多数颜色选择会去的地方。它使用Javadoc插件的配置部分中的样式表文件和样式表标签。

Maven显然使用JDK附带的stylesheet.css文件的修改版本。您可能想要比较JDK和Maven版本,以获得关于可以更改内容的一些想法。

+0

事实证明,我们遇到了比这更多的问题。资源文件夹甚至没有写入网站目录。我们发现我们忽略为pom文件中的网站插件添加版本号。一旦我们做到了这一点,所有的功能就开始融合在一起。然后,我们可以将maven-fluido-skin添加到sites.xml中,而不会出现任何构建错误,现在我们有语法着色。这一切看起来好多了。 – Miek