【问题标题】:How to get Doxygen 1.8 features in Xcode如何在 Xcode 中获取 Doxygen 1.8 功能
【发布时间】:2020-08-19 16:48:11
【问题描述】:

所以我试图在 Xcode (11.1) 中完全接受 Doxygen。

根据 Doxygen 文档,MarkdownLists 等功能应该在 Doxygen 1.8.0 及更高版本中得到支持。

如果我运行 doxygen --version 命令,它会告诉我我的版本是 1.8.3

但是当我尝试在我的 Objective-C Doxygen cmets 中使用 Markdown、列表和类似功能时,Xcode 的内置文档生成器似乎忽略了它们。

我错过了什么?是否有我必须设置/调整的魔法项目设置或 Doxygen 配置文件?

更新:这是一个我认为应该有效但无效的示例。

/** Called for each `DirectoryPackage` read during `buildSessions`
 *
 * Base class performs the final verification of the package references and adds all of the directory and file package
 * references to the session. Specifically:
 *    - ensures immediate file references are in this session
 *    - checks that all delta file and directory references are correctly inherited
 *    - performs session package reference accounting
 * @param info session details
 * @param directoryPackage the directory package
 * @param inheritedPackageSet package numbers belonging to inherited layers
 * @throws verify or inheritance exception
 */

这是在 Xcode 中如何格式化的:

【问题讨论】:

  • Doxygen 版本 1.8.3 是从 2012 年 12 月开始的,当前版本是 1.8.18 所以无论如何我都会更新你的 doxygen 版本(注意:我不知道这些 doxygen 功能在 XCode 中是如何使用的,所以我不知道单独使用 te doxyge update 是否足够)。
  • @Albert,虽然拥有最新版本通常很棒,但这并不能解决问题。我没有安装 Doxygen(我怀疑 Xcode 安装了),而且我应该已经拥有了我想要使用的功能。
  • 对降价和列表的引用是对最新文档的引用(尽管这些功能在 1.8.3 中也应该可用)。此外,功能可能存在已在最新版本中修复的错误。最好是给出一个小代码示例,说明它在 doxygen 中不起作用的内容(以及对 doxygen 配置文件的更改)。
  • 列表不起作用(-# 被忽略)。 Markdown 字符被忽略(`、*、**、_、__ 都被忽略并呈现为文字字符)。 Markdown 列表被忽略(1.、*、...)。这不仅仅是 1.8.3 和 1.8.18 之间一些模糊的不兼容。
  • 文字字符可能会提供线索,行前是否有 4 个空格?我用 1.8.3 做了一个快速的文本,但我看到 -# item 的结果是正确的,所以我认为一个例子/MWE 会很好。可能存在差异(并且在 Xcode 的 1.8.3 输出和 1.8.18 版本之间,但这是我无法判断的。我使用 HTML 作为参考)。

标签: objective-c xcode doxygen


【解决方案1】:

由于我想添加一些图片,因此无法在评论中显示。

1.8.18 和 1.8.3 的 HTML 文件中似乎存在基本信息。

XCode 似乎无法翻译 <ul> / <li> 元素。

【讨论】:

  • Xcode 的 HTML 文档渲染器确实支持列表,这可以通过拉出 NSCopying 协议的弹出文档等来证明。还要注意 Markdown 也没有渲染。所以这不是 Xcode 文档 UI 的限制。
  • 侧边栏:Xcode 没有自己的 HTML 渲染器。我确信它使用标准的 WebKit 视图,它完全支持所有现代 HTML/CSS/JavaScript。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2011-02-20
  • 2012-08-07
  • 1970-01-01
  • 2010-11-29
  • 1970-01-01
  • 2014-05-17
相关资源
最近更新 更多