Doxygenには回線継続機能がありますか？

debugcn 投稿 Dev

酸

ソースファイルの行の長さを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)）は、3つの整数パラメーターを受け取るコンストラクターを正しく指します。ただし、改行がある2番目のリンクは、単一の整数パラメーターのみを受け取るコンストラクターを指します（パラメーターリストもリンクの一部にはならず、関数名のみになります）。

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);
}

正確には行継続機能ではありませんが、問題は解決します。これで、両方のリンクが同一になり、3つの整数パラメーターを受け取るコンストラクターを正しく指し示します。

この記事はインターネットから収集されたものであり、転載の際にはソースを示してください。

侵害の場合は、連絡してください[email protected]