Doxygen 有续行功能吗?
Does Doxygen have a line-continuation feature?
我想将源文件中的行长度限制为 80 个字符。这是将 Doxygen 函数 links 转换为具有长原型的函数时的问题,例如因为参数的类型名称很长。
是否可以让 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);
}
生成文档时,第一个 link (MWE::func(int a, int b, int c)
) 正确指向采用三个整数参数的构造函数。但是,第二个 link,其中有一个换行符,指向仅采用单个整数参数的构造函数(参数列表也不会成为 link 的一部分,只有函数名称) .
有没有办法让 Doxygen 忽略换行符?
感谢阿尔伯特 , I started searching the Doxygen bug reports and found this related bug report. The bug report has now been migrated to Github here。
显然,诀窍是将换行符放在 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);
}
不完全是续行功能,但它解决了问题。现在这两个链接是相同的并且正确地指向采用三个整数参数的构造函数。
我想将源文件中的行长度限制为 80 个字符。这是将 Doxygen 函数 links 转换为具有长原型的函数时的问题,例如因为参数的类型名称很长。
是否可以让 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);
}
生成文档时,第一个 link (MWE::func(int a, int b, int c)
) 正确指向采用三个整数参数的构造函数。但是,第二个 link,其中有一个换行符,指向仅采用单个整数参数的构造函数(参数列表也不会成为 link 的一部分,只有函数名称) .
有没有办法让 Doxygen 忽略换行符?
感谢阿尔伯特
显然,诀窍是将换行符放在 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);
}
不完全是续行功能,但它解决了问题。现在这两个链接是相同的并且正确地指向采用三个整数参数的构造函数。