如果未注释C++;方法 我试图用C++项目来做文档丢失警告的DOXEGEN POP警告。 我试着把文件放进去 WARNINGS = YES EXTRACT_ALL = YES EXTRACT_ANON_NSPACES = YES
我还尝试:如果未注释C++;方法 我试图用C++项目来做文档丢失警告的DOXEGEN POP警告。 我试着把文件放进去 WARNINGS = YES EXTRACT_ALL = YES EXTRACT_ANON_NSPACES = YES,c++,doxygen,C++,Doxygen,我还尝试: WARNINGS = YES EXTRACT_ALL = NO EXTRACT_ANON_NSPACES = YES WARN_IF_UNDOCUMENTED = YES # (WARN_IF_UNDOCUMENTED is ignored if EXTRACT_ALL is enabled) 但什么也没发生 我不明白的是,如果我在printArgs方法上添加了不完整的Doxygen注释,我确实会收到一条警告,说一些参数没有文档化,但是如果我没有
WARNINGS = YES
EXTRACT_ALL = NO
EXTRACT_ANON_NSPACES = YES
WARN_IF_UNDOCUMENTED = YES
# (WARN_IF_UNDOCUMENTED is ignored if EXTRACT_ALL is enabled)
但什么也没发生
我不明白的是,如果我在printArgs
方法上添加了不完整的Doxygen注释,我确实会收到一条警告,说一些参数没有文档化,但是如果我没有添加Doxygen标记,我就不会收到任何警告
哪个Doxyfile字段可以启用此功能?这是一个很小的例子,我想在Jenkins服务器中使用这个警告功能来检查所有的方法和字段是否已经被记录
我要测试的代码非常简单:
main.cpp
#include <iostream>
#include "test.h"
using namespace std;
int main(int argc, char **argv)
{
cout << "Hello World !" << endl;
printArgs(argc, argv);
return 0;
}
#include "test.h"
#include <iostream>
using namespace std;
void printArgs(int argc, char **argv)
{
for (int i = 0; i < argc; i++)
{
cout << "Arg #" << argc << " : " << argv[i] << endl;
}
}
test.h生成警告(缺少“argv”的标记)
编辑:
我找到了一个部分解决我问题的解决方案:
发件人:
全局函数、变量、typedef和枚举的文档
仅当它们所在的文件为时,才会包含在输出中
如果EXTRACT_ALL设置为YES,则也会记录
从Doxyfile的WARN\u IF\u UNDOCUMENTED
注释中:
如果EXTRACT_ALL设置为YES,则此标志将自动禁用
因此,我想要的是将EXTRACT\u ALL
和WARN\u IF\u UNDOCUMENTED
设置为true,这是不可能的
我不明白为什么不可能,如果有人能解释一下,我将不胜感激。我唯一的解决办法是将/**\file*/
放在test.h
的顶部
这并不能完全解决我的问题,因为我想用这个“功能”跟踪丢失的注释,丢失的注释也可能是
/**\file*/
,如果是这样的话,我现在就被搞砸了…这是不可能的,因为事实上,EXTRACT\u ALL在过滤警告方面非常严格。我为doxygen()创建了一个建议的pull请求,以提供更多警告(尽管可能有很多警告)。
#pragma once
void printArgs(int argc, char **argv);
#pragma once
/**
* @brief
*
* @param argc
*/
void printArgs(int argc, char **argv);