【问题标题】:Doxygen style mainpage for MavenMaven 的 Doxygen 风格主页
【发布时间】:2016-10-25 03:50:16
【问题描述】:

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

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

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

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

我的问题:

谁能提供一个示例,说明如何在适当的 .apt 文件(examples.apt)或 sites.xml 文件中实现着色?

【问题讨论】:

  • 真的坚持使用 .apt 吗?为什么不使用降价?此外,您使用的是哪个网站皮肤?

标签: java maven doxygen


【解决方案1】:

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

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

【讨论】:

  • 事实证明我们遇到的问题比这还多。资源文件夹甚至没有写入站点目录。我们发现我们忽略了在 pom 文件中添加站点插件的版本号。一旦我们这样做了,所有的功能就开始融合在一起。然后,我们能够将 maven-fluido-skin 添加到 sites.xml 中而不会出现任何构建错误,并且我们现在有了语法着色。一切看起来都好多了。
猜你喜欢
  • 2015-01-21
  • 1970-01-01
  • 1970-01-01
  • 2013-09-16
  • 2015-08-18
  • 2012-11-02
  • 2014-09-12
  • 2018-09-18
  • 2011-03-13
相关资源
最近更新 更多