【发布时间】:2020-08-19 16:48:11
【问题描述】:
所以我试图在 Xcode (11.1) 中完全接受 Doxygen。
根据 Doxygen 文档,Markdown 和 Lists 等功能应该在 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
*/
【问题讨论】:
-
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