标签: doxygen

我用来Doxygen记录我的 C++ 代码。所有内容都以 HTML 格式很好地输出，除了像下面这样的属性/变量不是（根本不是）。

    /**
     * Flag to check whether the variable is once initialized or not
     */
     bool initialized_;

知道会出什么问题吗？

编辑

initialized_是类成员变量。

我知道类应该在 hpp 文件中定义。公司惯例要求我将这个特定的类保留在 cpp 文件中。

Doxygen 正在解析有问题的 cpp 文件并在其中记录一些 #define，但完全跳过了该类。我如何让 Doxygen 看到它？我可以在 doxyfile 或文件本身中放入一些内容吗？

众所周知，如何在 Doxygen 中获取 TODO 列表，输入：

\todo Item one
\todo Item two

等等，但是当某件事完成后，如何跟踪呢？

如果我已经完成了第二项，我不想删除它，我想将其标记为已完成：

\todo Item ono
\done Item two

我该怎么做呢？

我得到了这个示例代码。我想在我的简短评论中加一个点。

const int myVar = 1;   //!< Doxygen very long brief\.
                       //!  Brief sentence two.

我按照 doxygen 手册中的说明转义了点。这是行不通的。第一行很简短，第二行很详细。这是一个错误吗？

注意：MULTILINE_CPP_IS_BRIEF并且QT_AUTOBRIEF是YES！我使用最新版本（1.8.9.1）。

我想对 C/C++ 代码运行某种 linter 或静态代码分析，如果存在缺少文档的代码（例如没有 doxygen 样式文档注释的函数），则会发出警告。换句话说，我想强制执行某些代码标准。我研究了clang-tidy和cppcheck，但没有走得太远。

为了让我更清楚我对 Python 的期望，我习惯了这样的事情：

$ cat test.py 
def answer():
    return 42
$ python3 -m pylint test.py 
************* Module test
test.py:1:0: C0111: Missing module docstring (missing-docstring)
test.py:1:0: C0111: Missing function docstring (missing-docstring)

------------------------------------------------------------------
Your code has been rated at 0.00/10 (previous run: 0.00/10, +0.00)

Doxygen 有没有办法报告源代码是否已记录？有什么方法可以识别一组 C++ 源文件中没有详细记录的文件集吗？

• 编码语言：C++
• 文档工具：Doxygen（如果有验证选项，可以使用其他一些开放工具进行更改）

/// \brief  Main function
/// \param  argc An integer argument count of the command line arguments
/// \param  argv An argument vector of the command line arguments
/// \return an integer 0 upon exit success
int main(int argc, char** argv)
{
    /// Comments I would like to be documented in as well
    return 0;
}

我使用的命令如下

$> doxygen Doxyfile && echo "success" || echo "failed"

我在Windows 7电脑上安装了Doxygen 1.8.7。从此处下载示例项目。 启动Doxywizard填充了所有选项卡（项目，模式，输出，图表）上的值，但在完成所有这些操作后，仍然禁用下一步按钮。

找到下面的屏幕截图

我做错了什么？

我想使用doxygen创建并链接到中心词汇表.

为了创建词汇表,我会在doxygen搜索路径中使用"glossary.md"文件.内容可通过"相关页面"获得.

是否可以从我的文档中的任何位置链接到该词汇表页面中的条目？

最好的问候Andreas

按照doxygen手册中的示例，我构造了测试头test.h：

/**
 * @file test.h
 */

  /** @brief This is a struct 
   *  @var foo A foo.
   *  @var bar Also a Foo.
   *  @var baz (unused field)
   */
  typedef struct {
     int foo;
     int bar;
     char *baz;
  } whatsit;

当我使用默认值Doxyfile（由'生成doxygen -g）时，会看到警告：

... test.h：11：警告：未记录复合whatsit

... test.h：7：警告：未定义记录符号`foo A Foo`

... test.h：12：警告：未记录whatsit类的成员foo（变量）

是什么赋予了？我从手册中得到的印象是，您不需要标记，例如@struct注释直接位于定义之前，并且在上面的块中记录成员var是合法的，而不是使用它们声明的相同行/*< ...句法。（我绝对讨厌后者的风格...）

我该如何正确识别评论？

说我有A.jl,B.jl,C.jl,D.jl.在每个.jl中,有100个函数.当我尝试调用特定函数时,我需要搜索.jl以确定函数是如何定义的？是否有一种简单的方法可以将所有函数定义生成到HTML索引页面中.如果我可以单击该链接并查看该函数的实际源代码,它会更好.像Doxygen那样为C/C++生成文档,但Doxygen不支持Julia.谢谢.