如何使用Doxygen为Dash指定关键字?

时间:2013-02-03 22:23:38

标签: macos documentation doxygen

我正在使用Doxygen为我的项目生成文档,这会生成与dash几乎完美匹配的文档集。

我想知道的是如何在dash中设置搜索关键字;默认值为“unknown:”

Dash Docsets

我需要更改什么才能读取“未知:”以外的内容。我可以在Doxygen中更改吗?

1 个答案:

答案 0 :(得分:4)

我是Dash的开发者。 Dash使用docset中Info.plist文件中的DocSetPlatformFamily键来确定默认关键字。不幸的是,只要我知道设置这个值,Doxygen就没有选择。我将联系Doxygen团队并要求他们添加此选项。随意做同样的事。

目前,我最好的建议是编写一个后代脚本,在Info.plist文件中添加所需的密钥(它只是一个文本文件)。

例如,这应该有效:

perl -pi -w -e "s/<\/dict>/<key>DocSetPlatformFamily<\/key><string>__DESIRED KEYWORD__<\/string><key>DashDocSetFamily<\/key><string>doxy<\/string><\/dict>/s" Info.plist

注意:我还添加了一个值为“doxy”的“DashDocSetFamily”条目。这将导致Dash将doset作为Doxygen生成的docset处理,并显示可过滤的目录。

如果您还没有找到它们,以下是一些建议的设置,用于生成在Dash中使用的Doxygen docset:

SEARCHENGINE           = NO
DISABLE_INDEX          = YES
GENERATE_TREEVIEW      = NO