2017-10-14 19 views
0

ソースファイルの行の長さを80文字に制限したいと思います。これは、長いプロトタイプを持つ関数へのDoxygen関数リンクを作るときの問題です。パラメータの長い型名のためです。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のは改行を無視させる方法はありますか?

+0

どのバージョンのdoxygen aeをお使いですか? – albert

+0

\ detailはALIASとして\ detailを定義していない限り、\ detailをファイル内に読み込む必要がありますが、その場合はあなたの質問に言及するか、標準のdoxygenコマンドを使用するように質問を調整してください。 – albert

+0

@albert私はDoxygenバージョン1.8.13を使用しています。 – AcId

答えて

2

アルバートのcommentのおかげで、私はDoxygenのバグレポートを検索し始め、thisに関連するバグレポートが見つかりました。

どうやらトリックは、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つの整数パラメータを取るコンストラクタを正しく指しています。

+0

バグレポートにあなたの例を追加してください。問題を少し明るく照らしてくれます。 – albert

+0

@albertこの例をバグレポートに追加しました。ありがとう、非常に感謝:) – AcId

関連する問題