8

次のような関数のdoxygenヘッダーがあります。

/** Some description.

    @param[in]  grid1      First grid
    @param[in]  grid2      Second grid

    @pre grid1 and grid2 must be of the same dimensions
*/

生成されたドキュメントの前提条件のセクションでは、パラメーターであるため、特に強調したいと思いgrid1ます。grid2私の心の中で、私は次のようなことができるはずです

@pre #grid1 and #grid2 must be the same size

しかし、これは機能しません。

これを達成する方法について何か考えはありますか？

4

2 に答える 2

7

#関数の引数の定義に自動的にリンクされていると便利です。しかし、 doxygenマニュアルの自動リンク生成セクションでこれを行う方法をとにかく見ることができません。

strongドキュメントのHTMLソースを見ると、パラメータはクラスと同じように単純にスタイル設定されているように見えますparamname。だから何かのような

@pre <strong class="paramname">grid1</strong> and
    <strong class="paramname">grid2</strong> must be the same size.

あなたが望む結果を与えるはずです。明らかに、これは毎回書き出すのに過度に冗長です。ただし、これを行うためのカスタムコマンドを定義できる必要があります\paramname。これにより、次のように記述できます。

@pre \paramname{grid1} and \paramname{grid2} must be the same size.

編集：これは、構成ファイルのエイリアスを使用して実現できます

ALIASES += paramname{1}="<strong class="paramname">\1</strong>"
于 2012-06-19T08:58:20.943 に答える
1

答えを探してここに着陸しましたが、他の場所で見つけました。

\p次の単語が関数パラメーターであることを示すために使用します。

そしてもちろん、の@代わりに使用することもできます\。

/** Some description.

    @param[in]  grid1      First grid
    @param[in]  grid2      Second grid

    @pre @p grid1 and @p grid2 must be of the same dimensions
*/

DoxygenSpecialCommandsリファレンスを参照してください。

于 2017-12-10T23:07:40.320 に答える