Doxygen 未生成文件描述

Question

我正在使用 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

并在每行的开头添加 * 。我知道它们没有必要，但我真的无法理解为什么它根本不起作用。

提前谢谢您

Answer 1

正如 @albert 在评论中指出的那样，问题在于

$relPath

变量。它没有被定义，显然，它阻碍了对其余部分的正确解释。因此，只需删除该变量，它就会再次开始工作。结果是：

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