2

これは私がやったばかげたことだと確信していますが、それが何であるかわかりません：

だから私は main.cpp ファイルといくつかのクラスを持つ c++ プロジェクトを持っています。これは doxygen を念頭に置いて書かれたものではありません (エラー #1) が、間違いを修正してドキュメントを作成したいと考えています。そこで、doxygen をインストールして doxygen GUI を実行し、プロジェクト名と概要を入力して、ソースと宛先の場所を指定しました。

また、関数の上にいくつかの出力を取得するために、doxygen 仕様で必要なスタイルでコメントを追加しました。

//! My actual function doesn't really look like this
/*! 
 *  Some sample detail which isn't exactly the same as the main
 *  function but the structure is the same
 */
void sampleFunction()
{
    doSomethingUninteresting();
}

ただし、doxywizard で run を実行しても、追加のコメントは作成されません。

抽出モードを文書化されたエンティティに設定すると、main.cpp だけが表示されません。すべてのエンティティに設定すると、ファイルの下に main.cpp が表示され、関数はそこにありますが、ファイルには詳細がありません。

プロジェクトを改造しようとする完全な初心者として、重要なことを省略したことは間違いありませんが、読んだすべてのドキュメント/チュートリアルでは、実行する必要があると述べたこと以外は何も示唆していません。支援のための知識豊富な SO コミュニティ

アップデート：

Arne Mertz のコメントに応えて、いくつかの詳細を以下に示します。

  • Doxywizard は Program Files/doxygen/bin にあり、設定ファイルはデフォルトで doxywizard が作成する場所にあります

  • ソースコードは User/Desktop/ にあります

  • 出力フォルダは User/Desktop/Documentation にあります

4

2 に答える 2

1

グローバル関数を文書化するには、ファイル名も含める必要があります。例えば

/*!
 * \file MyFileName.cpp
 * \brief a brief description of a file
 */

//! My actual function doesn't really look like this
/*! 
 *  Some sample detail which isn't exactly the same as the main
 *  function but the structure is the same
 */
void sampleFunction()
{
    doSomethingUninteresting();
}

\fileキーワードの後の名前は、ファイルの名前と正確に一致する必要があることに注意してください。

于 2014-09-04T11:50:32.813 に答える