4

コンテキスト-生成されたRTFドキュメントへのCコードのDoxygenツール。

モジュール/グループのドキュメントでは、特定のモジュール/グループの詳細な説明が提供されていない場合でも、「詳細な説明」というヘッダーが表示されます。

生成されたRTFドキュメントでは、これは見苦しいように見えます。この空の詳細説明セクションを取り除くことは可能ですか？

試し"ALWAYS_DETAILED_SEC = NO"ましたが、動作しません。"HIDE_UNDOC_MEMBERS = YES"グループ/モジュールには文書化されているメンバー（構造体、関数など）が含まれているため、実行できません。

4

3 に答える 3

2

これは少し遅いかもしれませんが、他の人が興味を持っているかもしれません (私はそうでした)。

レイアウト ファイルを使用してグループの詳細な説明を完全に削除できますが、簡単な説明がある場合More...でもリンクが作成されます (何もリンクされません)。私の解決策は、グループの簡単な説明を無効にし、詳細な説明をページの上部に移動することでした (基本的には置き換えます)。

次のコマンドを実行して、レイアウト ファイルを作成しますdOxygen -l。デフォルトのレイアウト ファイルが作成されます。私たちが興味を持っているセクションは、一番下にあるグループです。

<!-- Layout definition for a group page -->
  <group>
    <briefdescription visible="yes"/>
    <groupgraph visible="$GROUP_GRAPHS"/>

フィールドに設定visible="yes"します。ファイルの下部近くにMove this to the top, above or belowが表示されます。あなたは今持っているはずです：visible="no"briefdescription<detaileddescription title=""/>briefdescription

<!-- Layout definition for a group page -->
  <group>
    <briefdescription visible="no"/>
    <detaileddescription title="Description"/>
    <groupgraph visible="$GROUP_GRAPHS"/>

タイトル フィールドに入力して、タイトルを「説明」に変更したことに注意してください。ファイルを保存します。Doxyfile で、カスタム レイアウト ファイルを指定する必要があります。次の行を追加します (または検索して入力します)。 LAYOUT_FILE=DoxygenLayout.xml

パスが正しいと仮定すると、簡単な説明が完全な説明に置き換えられたグループ ページが表示されます。

于 2014-06-30T16:48:46.437 に答える
1

残念ながら、クラスが次のように文書化されている場合は生成されません。

/// <summary>
/// This is..
/// </summary>
class ABC
{     
}

「概要」タグを削除します。つまり、次のようにする必要があります

///
/// This is..
///
class ABC
{

}

以下のリンクで詳細な説明（冒頭）を検索して ください http://www.star.bnl.gov/public/comp/sofi/doxygen/docblocks.html

于 2013-05-28T17:44:19.667 に答える