2016-03-20 3 views
4

私はC++プロジェクトに取り組んでおり、実際にはSphinxのドキュメント構築システムに恋していました。私はDoxygenとBreatheをセットアップして、SphinxにC++の記述を提供しました。Sphinx + Doxygen + Breathe:GoogleのCeresソルバーのようなドキュメントはどうすれば入手できますか?

GoogleのCeres Solverのドキュメントがどのように行われたかわかりません。たとえば、API referenceには、クラス名に続いてたくさんのテキストが含まれています。前のリンクに示すコードブロックの例もあります。 ソースファイル内にDoxygenのドキュメントを書いてこれを達成する方法はありますか?

もう1つの例は約2ページのテキストを持つthis class documentationです。私は何らかの形でこのテキストがDoxygenのコメントとしてソースファイルにあることを疑う。私は、すべての余分なテキストがドキュメントのための再構成されたテキストソースに書かれており、C++のソースファイルには何も書かれていないと感じています。しかし、doxygenを使用して呼吸をするのは何ですか?

のコードについての高度な情報はどこにありますか?私は、ソースにclass1class2を記載することができますが、どこかでそれらの両方がどのように相互作用し、一緒に使用されるかを説明する必要があります。これは、私の考えでは、Ceresソルバーのドキュメントがうまくいきます。

また、Sphinx + Doxygen + Breatheパイプラインとオープンソースのドキュメントを使用してC++プロジェクトを指摘できます。そして、私は自分自身でこれらのことをどうやって行うのかを見ることができます。残念ながら私はどのプロジェクトについても知らない。

+0

*「ソースファイル内にDoxygenドキュメントを書き込んでこれを達成する方法はありますか? * - [はい](https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html)。 – IInspectable

+0

@IInspectableありがとうございますが、私の事例をチェックしましたか?クラスのドキュメントには、コード例、再構成されたテキストのインラインマークアップなどが含まれています。 ReSTのインラインマークアップをソースに追加することはできますが、sphinxでは無視されるNOTE ::などのディレクティブは追加できません。 – Cat

+0

はい。 1分以内に数十ページの文書を読みましたか? – IInspectable

答えて

3

私はCeresソルバーのgithubリンクを見逃しました。ドキュメントのソースが見つかります。完全なドキュメンテーションはC + +コードの中ではなく、再構成されたテキストソースファイルで書かれているので、少し失望しています。基本的に彼らは.. class:: classNameでクラス名を参照してから、情報テキスト、サンプルコードブ​​ロックなどのReSTマークダウンを追加します。"Modeling Non-linear Least Squares"

関連する問題