3

問題

現在、以前のOpenOfficeの結果を再利用して、手動から自動化されたCコードドキュメントに移行したいと考えています。

バックグラウンド

過去10年間で、アーキテクチャのような散文、「仕組み」、グラフィックス、詳細なAPIの説明など、多くのOpenOffice（* .odt）ファイルを手動で生成しました。そのため、製品ごとに1つのドキュメントがありました（お客様向けに* .pdfとしてエクスポートされました）。

Doxygen互換のフォーマットとキーワードを使用するようにCコードを変更し、適切にフォーマットされたドキュメントを作成しました（HTML + CHM、これまでPDFはありません）。ただし、これにはもちろん詳細なAPIのみが含まれます。目的は、散文とグラフィックを含む単一の結果ファイルを生成することです。

OpenOfficeとDoxygenの結果を組み合わせることを考えて、私たちはどのようにそしてどの方向に進むべきか疑問に思っています：

  1. * .odt => * .htmlを変換し、DoxygenのCコードでこれらを参照します
  2. * .odt => * .txt / pngに変換し、DoxygenのCコードでこれらを参照します
  3. * .odt => * .htmlをベースとして変換し、Doxygen-HTML-これらのファイルの結果を参照します
  4. 両方の結果をマージするために利用できる別の一般的な形式（？）

質問

古いドキュメントスタイルから同等の単一のドキュメントファイル（Doxygenの結果を含む）に移行するための最も効率的な方法は何でしょうか？

4

1 に答える 1

2

Doxygenで完全なドキュメントを作成するのに非常に長い時間を費やした後、私は最近Sphinx + Breathe+Doxygenに移行しました。複数のツールの追加された複雑さは、使用可能なドキュメントを用意することで相殺される以上のものであることがわかりました。

DoxygenはAPIドキュメント用であり、インラインに保つことでAPIをコードで更新するように促すことができます。

Sphinxは、システムドキュメント、アーキテクチャの説明などに使用されます。Sphinxは、再構築されたテキストベースのドキュメントシステムであり、既存のODTドキュメントを変換する必要があります。

Breatheは、DoxygenのドキュメントをSphinxに取り込むためのブリッジです。DoxygenはXMLにコンパイルされ、BreatheはXMLを抽出して、コンパイルされたSphinxドキュメントにプッシュします。

Sphinx＆Breatheに代わるものは他にもあるかもしれませんが、このような分割を強くお勧めします。これにより、Doxygenは強力なAPIを実行でき、毎日戦う必要のないツールでより高いレベルのシステムドキュメントを実行できます。

于 2013-05-31T02:24:01.413 に答える