Question

请不要介意以下最小例子的陌生感（我必须把它做得更大才能证明我为什么这样做）：

文件test.cpp：

#include "a.h"

int main() {
  return 0;
}

文件a.h：

namespace N { // without namespace all is well!
#include "b.h"
}

文件b.h：

/// \file

#ifndef GUARD
#define GUARD

struct A {};
#define CMD 5 // without this, all is well!

#endif

Doxygen 1.8.11抱怨：

warning: Member GUARD (macro definition) of file a.h is not documented.

第一个有趣的事情是警告提及a.h。第二个是如果删除了任何一条注释行，警告就会消失。这是怎么回事？

Answer 1

你可以使用conditional documentation来suppress这样的Doxygen警告：

//b.h
/// \file

//! @cond SuppressGuard
#ifndef GUARD
#define GUARD
//! @endcond

struct A {};
//! @cond SuppressCmd
#define CMD 5 // without this, all is well!
//! @endcond

//! @cond SuppressGuard
#endif
//! @endcond

请注意，我将#endif与cond包裹起来，因为否则您将收到if-endif不匹配警告：

/home/user/doxygen/b.h:13: warning: More #endif's than #if's found.

Doxygen要求记录包含防守

1 个答案: