5
すべてのCヘッダーファイルに含まれるC APIを文書化しようとしています。ファイルにdoxygenを実行すると、現在ドキュメント化されていないCマクロのエラーが出ますが、マクロに必要なドキュメントを追加すると、文書化されていないエラーはクリアされますが、doxygenによって生成されたhtml出力には、ドキュメントがdoxygen出力に表示されない
ドキュメント化されたヘッダーファイルのほんの一部(構造体)が、実際にdoxygen出力に表示されます。 doxygenがヘッダーファイルの文書化されたコードを生成された出力に配置しない理由を明確にするのに役立つ構成設定やドキュメントで何も見ることができません。
これがなぜこのようになるのか誰も知っていますか?
@fileコメントはファイル内にあり、faq内の解決方法のいずれも違いを生じません。それらは名前空間について話しているクラスベースの方法で書かれていますが、私はまっすぐなCヘッダーなので、faqの解決策が私を助けない理由を説明するかもしれません。 – jwhitmore
@fileは機能しているはずですので、自己完結型の例(ここまたはdoxygenのバグトラッカー)を投稿してください。問題を自分で再現できます。 – doxygen
おっと! @fileは、実際のファイルのドキュメントでもっと多くのことを文書化していますが、私が本当に欠けているのはAPI関数です。残念ながら、ヘッダーでは、API関数は関数へのCポインターとして宣言されています。私はそれらを "\ fn"で文書化していますが、これらはまったく表示されません。 – jwhitmore