Doxygenでローカルプロシージャを隠す

Doxygenの特殊コマンドを眺めていてローカルプロシージャを隠せそうなコマンドを見つけたのでテスト。

ローカルプロシージャを使っているＭＥＬのサンプルは、カーブポイントの座標を表示するのスクリプトを使ってみます。

使うコマンドは@private
保護レベルをサポートしていない言語向けのコマンドらしいです。

proc string _round(
       int $digit,                      //!< 区切る桁数
    string $mode,                       //!< 出力モード
     float $value )                     //!< 区切る値
/**************************************************************************//**
    @private
    @brief 指定の桁数で四捨五入する。
    @return 四捨五入  [string型] を返す。
 ******************************************************************************/
{
    float $mlt=pow( 10, $digit );

tryPrintCurvePointPositions.melから抜粋

こんな感じで、隠したいプロシージャに記述しておくと、

こんな風に、出力されたドキュメントには _round() のローカルプロシージャが表示されなくなります。

このコマンドが書かれているブロック単位で消してくれるようですね。

で、リファクタリングなんかする場合にはローカルプロシージャも確認したくなるので、そんな時には Export - Build の EXTRACT_PRIVATE にチェックを入れて出力します。

すると今度は、こんな感じでローカルプロシージャも見えるようになります。

この _round の詳解を見てみると・・・

[private]のアイコンが追加されています。

なかなか良いんじゃないでしょうか。

このほかに @defgroup と @{ @} を使った方法も試してみましたが、こちらは挙動が安定しないみたいで出力結果が安定しませんでした。

余計なことせず ＠private を使うのが手っ取り早いようです。