如何解决从 Doxygen 中删除源代码但保留方法参数名称
在 C++ 项目中,我在标题中描述方法和函数,如下所示:
int foo(float,bool,std::string);
在我的实现中,命名参数:
int
foo(float f,bool b,std::string str)
{
...
}
如果我使用带有 SOURCE_BROWSER=NO
、VERBATIM_HEADERS=NO
和 EXTRACT_ALL=YES
的 Doxygen 生成我的文档,那么生成的文档包含函数签名带有的参数名称我想要的是。但我的所有 .cpp
文件也都位于标题旁边的“文件列表”部分。
我想完全隐藏我的源文件,但我也想让我的文档包含参数名称,而不必通过项目并将数千个添加到包含中。 >
我已经尝试将 src/
文件夹添加到 EXCLUDE
中,它确实隐藏了源代码,但是它们根本没有被解析,并且出现了相反的问题,参数再次是无名的。
有什么办法可以让我吃蛋糕也吃吗?
解决方法
事实证明,如果我禁用 EXTRACT_ALL=yes
并将 @file
添加到仅我想显示的文件的开头(因此所有标题),那么我可以在隐藏源的同时保留参数名称文件。
鉴于未记录的函数将不再显示,这可能不是最佳解决方案,但由于它们都在此项目中,因此不会造成问题。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。