doxygenはmain.cppを処理しません

StackOverflow https://stackoverflow.com/questions/3990533

  •  10-10-2019
  •  | 
  •  

質問

だから私はDoxygenを使用するのは初めてで、それをスムーズに動作させることができました。クラスと構造体を文書化することができ、HTMLファイルを完全に生成しました。私が遭遇している問題は、main.cppファイルを解析しないということです。すべてのクラスと構造体には独自の.hおよび.cppファイルがあり、それらは正常に処理されます。 main.cppのドキュメントを作成するにはどうすればよいですか？プログラムが開始および終了する場所であるため、.hファイルはありません。メイン用の.hファイルに何を入れるべきかさえ知りません。 WindowsでDoxyWizardを使用しています。

編集：

これをメインに入れて、メインページを生成します。

/**
@mainpage

This is a test application.

@author Alex
@date 10/21/2010
@version 1.0
*/

しかし、関数プロトタイプがあるファイルをさらに下って私はこれを持っていますが、それは解析されません：

/**
@brief Error handler for the PDF writer.

It does nothing. It just has to exist.
*/
void error_handler (HPDF_STATUS   error_no,
                    HPDF_STATUS   detail_no,
                    void         *user_data)
{
}
役に立ちましたか？

解決

これをmain.cppの上部に置きましたが、うまくいきました。図に行く。

/**
@file main.cpp
*/

他のヒント

もしも INPUT と FILE_PATTERNS 空であるため、現在のディレクトリで *.cppファイル（および他の多くのパターン）を検索する必要があります。 （これから ドキシゲンマニュアル.)

あなたのものは空いているので、main.cppドキュメントを取得していない場合、2つのことのいずれかが進行していると思います。

  1. main.cppは現在のディレクトリにありません。これを除外するには、同じディレクトリからdoxygenを実行していることを確認してください 両方とも 構成ファイルとmain.cpp。
  2. main.cppドキュメントには構文エラーがあります。 Doxygenが一般的にエラーに遭遇したときに中断しないため、これらは見つけるのが難しい場合があります - 代わりに、それはただスキップします。これが問題である場合は、ドキュメントごとにLINEを生成するときにDoxygenの出力を調べます。

これらのアイデアのいずれも問題を解決しない場合、より多くの情報が必要になる場合があります。の出力 ls -R, 、Doxygen Runなどの出力。幸運を！

私はこれについていくつかの研究をしました...から ドキシゲンマニュアル :

重要： グローバル関数、変数、typedef、およびenumsのドキュメントは、それらがあるファイルも文書化されている場合にのみ出力に含まれます。

そこに行きます！

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top