Doxygen 未生成文件说明-解网

问：

我正在编写 Doxygen 项目的文档，除了文件的描述外，一切都或多或少按预期工作。在文件的开头，我有：

/**
  @file $relPath
  @copyright $copyright
  @author dcasado
  @brief Description test
*/

但是，当打开 HTML 并访问文件列表时，没有一个文件有描述。Doxygen 正确理解该文档的语法，因为它在访问文件的源代码时隐藏了该部分代码。/** */

@brief 参数适用于类和函数，只有在文件中才会失败。

我的文件是 .ctl，但映射到 .cpp 类型。

由于我无法在此处复制所有 doxyfile，因此我只复制了从默认值更改的配置：

OUTPUT_DIRECTORY       = D:/DCasado/Desktop
TAB_SIZE               = 2
EXTENSION_MAPPING      = ctl=c++
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_PRIV_VIRTUAL   = YES
EXTRACT_PACKAGE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_METHODS  = YES
EXTRACT_ANON_NSPACES   = YES
RECURSIVE              = YES
INPUT                  = C:/WinCC_OA_Proj/NaturgyCCR/NTGY_sys1/NTGYProj_sys1/scripts
SOURCE_BROWSER         = YES
GENERATE_TREEVIEW      = YES

我尝试更改配置并阅读所有配置文档，但似乎任何事情都是解决方案。我还尝试在每行的开头更改和添加 *。我知道它们没有必要，但我真的无法理解为什么它根本不起作用。@brief\brief

先谢谢你

多氧多西向导

您是否删除了，因为当它存在时，您应该收到类似“警告：作为 \file 语句中的参数提供的名称'relPath'不是输入文件”的警告。我还假设该文件位于目录中。可能我发现了问题，看起来您没有添加到设置中。$relPathctlC:/WinCC_OA_Proj/NaturgyCCR/NTGY_sys1/NTGYProj_sys1/scripts*.stlFILE_PATTERNS

答：

0赞 diego 11/15/2023 #1

正如@albert在评论中指出的那样，问题在于变量。它没有被定义，显然，它阻碍了对其余部分的正确解释。因此，只要删除该变量，它又开始工作了。结果是：$relPath

/**
  @file
  @copyright $copyright
  @author dcasado
  @brief Description test
*/

上一个：是否有适用于 C 标准库的 Doxygen 标签文件（如可用于 C++ 的文件）？

下一个：如何使用 CI 和 doxygen 来了解新代码是否被很好地记录下来

Doxygen 未生成文件说明

Doxygen isn't generating descriptions for files

评论