タグ付けされた質問 「doxygen」

4
Xcode 5で利用できる新しいドキュメントコマンドは何ですか?[閉まっている]
閉まっている。この質問はスタックオーバーフローのガイドラインを満たしていません。現在、回答を受け付けていません。 この質問を改善してみませんか?Stack Overflowのトピックとなるように質問を更新します。 2年前休業。 この質問を改善する Xcode 5の新機能の 1つは、独自のコードを特別なコメント構文で文書化する機能です。形式はdoxygenに似ていますが、これらの機能のサブセットのみをサポートするようです。 サポートされているコマンドとサポートされていないコマンドを教えてください。 それらの使用法のいずれかがdoxygenと異なりますか?

4
C ++プロジェクト構成(gtest、cmake、doxygenを使用)
私はプログラミング全般に慣れていないので、C ++で単純なベクトルクラスを作成することから始めることにしました。ただし、後でワークフローを変更するのではなく、最初から良い習慣を身に付けたいと思います。 現在、ファイルは2つvector3.hppとしかありませんvector3.cpp。このプロジェクトは、私がすべてに慣れるにつれてゆっくりと成長し始め(一般的な線形代数ライブラリーのようになります)、後で人生を楽にするために「標準」プロジェクトレイアウトを採用したいと思います。だから周りを見回した後、私はhppとcppファイルを整理しようとする2つの方法を見つけました、最初のものは: project └── src ├── vector3.hpp └── vector3.cpp そして二番目の存在: project ├── inc │ └── project │ └── vector3.hpp └── src └── vector3.cpp あなたはどちらを勧めますか、そしてその理由は? 次に、コードの単体テストにGoogle C ++ Testing Frameworkを使用したいと思います。かなり使いやすいようです。あなたは、例えば、私のコードでこれをバンドル示唆くださいinc/gtestまたはcontrib/gtestフォルダ?バンドルされている場合、fuse_gtest_files.pyスクリプトを使用して数やファイルを減らすか、そのままにしておくことをお勧めしますか?バンドルされていない場合、この依存関係はどのように処理されますか? テストを書くことになると、これらは一般的にどのように編成されますか?各クラス(test_vector3.cppたとえば)ごとに1つのcppファイルを作成することを考えていましたが、すべてを簡単に一緒に実行できるようにすべて1つのバイナリにコンパイルしましたか? gtestライブラリは一般にcmakeとmakeを使用してビルドされるので、私のプロジェクトもこのようにビルドするのは理にかなっていると思いましたか?次のプロジェクトレイアウトを使用することにした場合: ├── CMakeLists.txt ├── contrib │ └── gtest │ ├── gtest-all.cc │ └── gtest.h ├── docs │ └── Doxyfile …
123 c++  cmake  doxygen  googletest 

6
Doxygenで紹介ページを作る方法
Doxygenを使用してSDKのドキュメントを作成しました。これには、ファイル、名前空間、クラス、タイプなどのリストが含まれています-私がコードにDoxygenコメントとして配置したものすべて。ここで、SDK(導入の種類)に関する一般的な情報を記述します。これは、コード要素に直接関連していません。この紹介をドキュメントのスタートページに配置します。これどうやってするの?
102 doxygen 

8
内部ライブラリのdoxygenコメントブロックを配置する場所-HまたはCPPファイル内?[閉まっている]
休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか?この投稿を編集して質問を更新し、事実と引用で回答できるようにします。 2年前休業。 この質問を改善する 常識では、Doxygenコメントブロックは、クラス、構造体、列挙型、関数、宣言があるヘッダーファイルに配置する必要があります。これは、ソースなしで配布されることを意図したライブラリ(ヘッダーとオブジェクトコード付きのlibのみ)の健全な議論であることに同意します。 しかし...私は、会社の内部(または私自身のサイドプロジェクト)のライブラリを開発するときに、その完全なソースコードで使用される、まったく逆のアプローチを考えていました。私が提案するのは、ヘッダーで宣言されたクラスと関数のインターフェースを混乱させないために、実装ファイル(HPP、INL、CPPなど)に大きなコメントブロックを配置することです。 長所: ヘッダーファイルの乱雑さが減り、追加できるのは関数の分類のみです。 たとえばIntellisenseが使用されるときにプレビューされるコメントブロックは衝突しません-これは、.Hファイルに関数のコメントブロックがあり、同じ.Hファイルにそのインライン定義がある場合に観察された欠陥です。 .INLファイルから含まれています。 短所: (明白なもの)コメントブロックは、宣言があるヘッダーファイルにはありません。 それで、あなたは何を考え、そしておそらく提案しますか?

5
Doxygenを使用してPythonコードを文書化する方法[クローズ]
クローズ。この質問はもっと焦点を合わせる必要があります。現在、回答を受け付けていません。 この質問を改善したいですか?質問を更新して、この投稿を編集するだけで1つの問題に焦点を当てるようにします。 2年前に閉鎖されました。 この質問を改善する 私はDoxygenがCまたはPHPコードのドキュメントを作成するのが好きです。私は今後のPythonプロジェクトを持っていますが、Pythonには/* .. */コメントがなく、Pythonのように文書化する独自の自己文書化機能もあることを覚えていると思います。 私はDoxygenに精通しているので、それを使用してPythonドキュメントを作成するにはどうすればよいですか?特に気をつけなければならないことはありますか?

1
同じパッケージでroxygen2とdoxygenを使用していますか?[閉まっている]
休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか?この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 この質問を改善する をR使用するパッケージがありますroxygen2。にはいくつかのCコードが/srcあり、私はDoxygenでの作業を始めたところです。ドキュメントを組み合わせる方法、またはコンパイルをroxygen2と統合する方法はありますか?Cコードドキュメントを配置する場所の「ベストプラクティス」はありますか? roxygen2とdoxygenのグーグルは主にroxygenにつながり、doxygenの結果と似ています。Doxyfilesを含むパッケージをいくつか見つけましたが、一貫した組織がありません。たとえば、lme4は、ソースディレクトリの外部inst/doc/Doxyfileと呼ばれるフォルダーに出力します。MatrixのルートディレクトリにもDoxyfileがあります(以前のリリースではにありました。このドキュメントもパッケージディレクトリの外にエクスポートされます)。doxygenlme4inst Cパッケージ内にドキュメントを含めない理由はありますか?または、広く使用されているにもかかわらず、Rパッケージ内でDoxygenがあまり使用されないのはなぜCですか? 更新:関連するroxygen2機能リクエストを参照

6
doxygenを使用してC ++ソースからUMLクラス図を作成する方法
doxygenを使用して簡単なクラス図を生成する方法を説明した資料を探していましたが、見つかりませんでした。誰か助けてもらえますか? C ++ファイルのセットから、以下に示すような図を作成する必要があります。 これを簡単に実現するためのより良いツールがある場合は、お知らせください。

6
PDF作成中のマークダウンの改ページ
doxygen(1.8.6)を使用してマークダウンテキストファイルのPDFを作成しています。マークダウンファイルの特定の段階で改ページを取得したいので、このリンクを使用しました。 与えられたリンクで、彼らは改行に「>」を使用することに言及しました。しかし、彼らは改ページについて言及していません。はい、改ページにも「>」を使用できますが、この記号をマークダウンテキストファイルに5回以上書き込む必要があるため、マークダウンファイルの外観がおかしくなります。マークダウンファイルで改ページを取得する他の方法はありますか?
84 markdown  doxygen 
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.