ライブラリを doxygen でドキュメント化したいと考えています。ドキュメントは、外部 API のみに関心のあるユーザーと、すべての機能/構造のドキュメントを見たい開発者の 2 つのクラスの人々によって読まれます。
ドキュメントを作成するためにdoxyfileを分離するために使用したいと思います。コメントを内部/外部としてマークするためにコメントブロックに入れることができる「タグ」はありますか?
7746 次
3 に答える
18
INTERNAL_DOCSを設定します：
# The INTERNAL_DOCS tag determines if documentation
# that is typed after a \internal command is included. If the tag is set
# to NO (the default) then the documentation will be excluded.
# Set it to YES to include the internal documentation.
INTERNAL_DOCS = NO
ドキュメントでは、\internalまたは@internal任意の粒度（ファイル、関数など）で使用できます。
于 2012-06-14T03:09:39.353 に答える
13
\condコマンドを使用します。
\internal( @internal) は、現在のコメント ブロックの粒度のみを持ちます。C で構造体定義を非表示にすることはできません。
これを行う最も簡単な方法は
\cond 内部
内部ヘッダファイルの先頭に
\endcond
底に。次に、構成ファイルに追加します
ENABLED_SECTIONS = 内部
内部アイテムをドキュメントに含めることができるようにします。
この方法は、Doxygen ユーザーにも推奨されています。
于 2013-08-26T12:22:48.180 に答える