Question

我想将源文件中的行长限制为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);
}

生成文档时，第一个链接（MWE::func(int a, int b, int c)）正确指向带有三个整数参数的构造函数。但是，存在换行符的第二个链接指向构造函数只接受一个整数参数（参数列表也不会成为链接的一部分，只有函数名称）。

有没有办法让Doxygen忽略换行符？

Answer 1

感谢albert的comment，我开始搜索Doxygen错误报告并找到this相关的错误报告。错误报告现已迁移到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);
}

不完全是行继续功能，但它解决了问题。现在两个链接都是相同的，并正确指向构造函数，它采用三个整数参数。

Doxygen是否具有线延续功能？

1 个答案: