doxygen

0熱

1答えて

私は、パラメータまたは戻り値を持たないいくつかの関数を持っています。私はこのような何かするとき：「なし」私は何のパラメータを知らないではないについての警告を取得します /*! * @fn * * @brief ... * * @param None. * * @return None. */ を結果のHTMLドキュメントは「なし」を強調表示します。あたかもそれが文字通りのパラ

0熱

1答えて

DoxygenでTOCにインデックスを追加する

Doxygenを使用してCプロジェクトのドキュメント（PDF）を作成しています。 TOCにインデックスを表示したいと思います。これは[pdf] latexとsimple enoughです。問題＃1：私はtocbibindパッケージまたはidxlayoutパッケージを使用できません（上記のリンクを参照）。私はDoxygenの EXTRA_PACKAGES = [nottoc]tocbibind

2熱

1答えて

Doxygenクラス図の可視性指定子としての星の意味

C++コードからDoxygenによって生成されたUMLスタイルのクラス図には、可視性修飾子に '*'が付いています。（fooで）とフレッド（）この嘲笑アップの例では： public: virtual void foo() = 0; protected: virtual void bar() = 0; public: virtual void fred() = 0; 出力は次のようになりま

1熱

2答えて

DoxygenコードブロックでDoxygenを使用することを示す

Doxygenを使用して特定のコンテキストでDoxygenを使用するためのベストプラクティスを示す文書を作成しています。私はいくつかのドキュメントを持っているには、次の形式を取ります。（私はDoxygenのの値下げ拡張子を使用していますことに注意してください） Best practices for documenting ============================== Do

3熱

1答えて

Windows用DoxygenのDOTパスの環境変数

私のチームにはWindowsとLinuxを使用している開発者がいます。 Doxyfilesは、バージョン管理システムに格納します。そのため、私たちはDOT_PATHを空白のままにしています。コードレビューを行うためにリポジトリから引き出すときは、常にDOT_PATHをローカルで変更する必要があります。 DOT_PATHが空のときにDoxygenが常にDotを見つけるように、WindowsのPATH

0熱

1答えて

Doxygenはスタンドアロン関数のドキュメントを生成しません

私が使用しているdoxygen設定は、クラス、構造体、および名前空間に適していますが、スタンドアロン関数のドキュメントは生成しません。例えば、何もこれらのメソッドのために生成されていない： #ifndef STRING_UTILS_H #define STRING_UTILS_H 1 /// @file /// @brief Trim whitespace from the start

0熱

1答えて

二つのREADMEファイル、doxygenは間違ったもの

プロジェクト構造選ぶ： Project root Doxyfile1 Doxyfile2 README.md Subdir README.md Doxyfile1をエンドユーザーのドキュメントの場合は、内部文書、Doxyfile2ためのものです。 Doxyfile1文書全体プロジェクト、Doxyfile2文書Subdirのみ。エンドユーザー

0熱

1答えて

doxywizardを使用して構造体の戻り値の型で関数を正しくドキュメント化するにはどうすればよいですか？

doxywizardが実行されたときに文書化されるように、構造体Entity * NewEntity（）を正しく文書化する方法を見つけ出すことができませんでした。 "警告：ファイルentity.hのメンバNewEntity（）（関数）は文書化されていません。" はまだ、コードは次のとおりです。ドキュメントを読ん /******************************************

0熱

1答えて

doxygenのドキュメントをより魅力的にするレイアウトの例はありますか？

doxygenのドキュメントはどのように見えるのでしょうか、私は本当にびっくりしました。例えばKDEです。自分のパッケージにも同様のスタイルを使用したいと思います。誰も私のドキュメントを見栄え良くするためにdoxygenを設定する方法を教えてもらえますか？私はこれをすべてthisを使って行うことができると仮定していますが、スタイルシートやレイアウトXMLファイルがあればどこでも入手できます。私は

0熱

1答えて

Doxygen：複数の実装を持つ単一のAPIを文書化する

2つの関数を持つヘッダーファイルと、ヘッダーが提供する関数を実装する複数のソースファイルがあるとします。私はDoxygenを使って関数を文書化したいと思いますが、実装固有のものではなく、すべての実装に関する一般的なコメントだけを書いています。ヘッダーコメントのみを表示するにはどうすればよいですか？プロジェクト内の他のソースファイルにはヘッダーがまったくないため、すべてのソースファイルを無視する