AcI*_*cId 4 doxygen line-breaks
我想将源文件中的行数限制为80个字符。当使Doxygen函数链接到具有较长原型的函数时,这是一个问题,例如,由于参数的类型名较长。
生成文档时,Doxygen是否可以忽略注释中的换行符(即行继续)?
这是MWE:
我有以下文件名为 mwe.cpp
/**
* \file mwe.cpp
*
* \details
* MWE::MWE(int a, int b, int c)
* MWE::MWE(int a,
* int b, int c)
*/
class MWE
{
public:
/**
* \brief constructor with one parameter
*/
MWE(int a);
/**
* \brief constructor with three parameters
**/
MWE(int a, int b, int c);
}
Run Code Online (Sandbox Code Playgroud)
生成文档时,第一个链接(MWE::func(int a, int b, int c))正确指向带有三个整数参数的构造函数。但是,第二个链接(其中有一个换行符)指向仅接受单个整数参数的构造函数(参数列表也不会成为链接的一部分,而仅成为函数名称)。
有没有办法让Doxygen忽略换行符?
感谢albert的评论,我开始搜索Doxygen错误报告,并找到了这个相关的错误报告。该错误报告现已迁移到此处的 Github 。
显然,诀窍是将换行符放在HTML注释中。
MWE生成的代码为:
/**
* \file mwe.cpp
*
* \details
* MWE::MWE(int a, int b, int c)
* MWE::MWE(int a, <!--
* --> int b, int c)
*/
class MWE
{
public:
/**
* \brief constructor with one parameter
*/
MWE(int a);
/**
* \brief constructor with three parameters
**/
MWE(int a, int b, int c);
}
Run Code Online (Sandbox Code Playgroud)
不完全是行连续功能,但它可以解决问题。现在,两个链接都是相同的,并且正确指向使用三个整数参数的构造函数。
| 归档时间: |
|
| 查看次数: |
669 次 |
| 最近记录: |