私は、Doxygen を使用して一連の C ライブラリを文書化する大規模なコード プロジェクトに貢献しています。また、関連する Python モジュール用にdoxypyとともに doxygen を使用し始めています。
コマンドライン プログラム (python または C) とそのコマンド ライン オプションを (自動的に) doxygen を使用して文書化する簡単な方法はありますか?
質問する
469 次
1 に答える
1
ページを生成するには、タグを [はい] (.doxyfile)manに設定する必要があります。GENERATE_MAN
デフォルトでは、man という名前のサブフォルダーOUTPUT_DIRECTORYが、生成されたページを格納するために を使用して指定されたディレクトリー内に作成されます。
そうすることで、doxygen はソース コードに追加したすべてのマークアップをマニュアル ページ (翻訳単位ごとに 1 ページ) としてレンダリングします。
この時点で、無視したい特定の部分を除外することができます (メインの呼び出し方法のみを示すことに関心があると思います) 。 exclude* ディレクティブを使用します。
2 つの異なる doxyfile をコンパイルすることをお勧めします。1 つは内部使用用 (完全な javadoc のようなドキュメント) で、もう 1 つはプログラム man などを生成するためです。
もちろん、最初の試行では期待どおりの結果が得られないため、doxygen マークアップを少しいじる必要があるかもしれません。
于 2013-03-27T19:33:20.520 に答える