Doxygenで@parと@paramを組み合わせてみた

前回 doxygen のコメントブロックで @par とリストを混ぜてみましたが、もう一つ気になることがありました。Doxygenの日本語訳マニュアルにはこう書かれてます。

これは、他のパラグラフコマンド (\param や \warningなど) の内部でも機能します。その際、そのコマンドを終了させることはありません。

@paramの内部でも。

他のパラグラフのような表題とインデントされた本文より、 @param で生成される引数リストはちょっと複雑な構成になってます。ここに @par を混ぜた場合、 パラグラフは引数リストと同列に並ぶのでしょうか、説明文の部分に追加される形になるのでしょうか。

というわけで、前回のHello world的なソースのmain()に、こんなコメントを付けてみました。

///     @brief  main関数
///
///     @param[in]  argc    おやくそくのargc
///                         @par
///                         続きのパラグラフ
///     @param[in]  argv    おやくそくのargv
///
///     @return 0しか返さない
///
///     C言語の典型的なHello world
///

これを出力した結果はこうなりました。

main関数

引数:

       

[in]

argc

おやくそくのargc

続きのパラグラフ

引数:

       

[in]

argv

おやくそくのargv

戻り値:

0しか返さない

C言語の典型的なHello world

……何か引数の見出しが2つできてるんですけど。@param 終了させてるんじゃないの、これ。