我可以将doxygen解析为@ ref到C++标准库函数吗？

Question

我有时想在我的doxygen评论中提到标准库构造.我可以使用HTML <a>元素执行此操作- 但这是要粘贴的大量文本.我宁愿能简单地写{@ref std::string},并有doxygen的知道它需要链接到cppreference.org 页面的std::string.

我想也许如果有人要为标准库生成一个doxygen标签文件(如果标签文件不支持任意URL,那么这可能不起作用)也许是可能的.那么,还有另一种方法吗？

Answer 1

你应该有一个Doxygen标签文件和相应的离线或在线html文件.因此,您可以使用以下格式在Doxygen配置文件中声明它:

TAGFILES = "/location/of/tagFile=http://onlineUrl Or /location/of/OfflineHtml"

要下载这些文件,我发现以下两个资源:

Cppreference

我推荐这种方式.因为它的完整文档.

在线链接

1. 下载网络代码文件.

2. 在配置文件中设置如下:

   TAGFILES += "location/of/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/"
   

离线链接

1. 下载html书籍,该书籍是该网站的离线副本.

2. 在配置文件中设置如下:

   TAGFILES += "location/of/cppreference-doxygen-local.tag.xml=/location/of/html_book_*\reference\en"
   

更多

GNU项目

在线链接

1. 下载最新版本的标签文件.

2. 在配置文件中设置如下:

   TAGFILES = "/location/of/libstdc++.tag = http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen"
   

离线链接

1. 下载HTML中的GCC 7.1标准C++库参考手册.在这里找到其他版本.

2. 在配置文件中设置如下:

   TAGFILES = "/location/of/libstdc++.tag = /location/of/libstdc++-api-html"
   

更多