c++ - 为 C++ STL 头文件生成 Doxygen 文档

标签 c++ c++14 doxygen gnu

尝试为 GNU C++ STL header (位于 /usr/include/c++/6/ 目录)生成 Doxygen 输出。它有点工作,它生成输出但结果相当微不足道 - 没有为例如 std::vector 公共(public)函数等生成文档。头文件函数看起来注释正确但仍然无法获得所需的输出。

尝试调整 Doxyfile 中的许多条目(RECURSIVE、EXTRACT_ALL 等),但没有成功。 任何指针将不胜感激。

$ doxygen --version
1.8.13

例如,std::vector::swap() 函数的注释如下所示:

 /**
  *  @brief  Swaps data with another %vector.
  *  @param  __x  A %vector of the same element and allocator types.
  *
  *  This exchanges the elements between two vectors in constant time.
  *  (Three pointers, so it should be quite fast.)
  *  Note that the global std::swap() function is specialized such that
  *  std::swap(v1,v2) will feed to this function.
  */
void
swap(vector& __x) _GLIBCXX_NOEXCEPT
{
     //....
}

最佳答案

不是答案,但我想包含一张图片。

我按照指示获取代码,一个普通的 Doxyfile,只有 EXTRACT_ALL 设置为 YES,我得到:

enter image description here

我可能会忽略一些东西,但这对我来说看起来不错。 如果我忽略了某些内容,请在原始问题中指出它作为编辑。

  • 您使用的文件名是什么?

一些旁白:

  • 当前的 doxygen 版本是 1.8.15
  • 另请查看 _GLIBCXX_NOEXCEPT 的“预处理”一章>

关于c++ - 为 C++ STL 头文件生成 Doxygen 文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/55583491/

相关文章:

c++ - 如何使用 Clang 从此示例中获取基类?

c++ - .tpp 文件中的 doxygen 和模板问题

c++ - 从 braced-init-list 初始化私有(private)聚合

c++ - 在填充成员 vector 期间避免复制构造函数

c++ - 在 constexpr 函数中改变 int

c - 使用 doxygen 获取完成列表

doxygen - 我可以抑制 Doxygen 类引用页面上的 'More...' 空链接吗?

c++ - Qt Creator 构建项目 - 没有这样的文件或目录

c++ - 如何判断头文件包含在哪里?

c++ - 未定义行为的解释,以及它是否真的未定义