文書の過去の版を表示しています。

Doxygen記述ルール

C/C++言語のソースを記述例について説明。

「Doxygen マニュアル」の特に下記ページを参照。

設定ファイル「Doxyfile」は、doxygen -g コマンド実行でデフォルト値ファイルが生成できる。特に下記項目について留意して設定する。

必須	設定項目	設定値	備考
◎	`PROJECT_NAME`	`"μNETマスター通信 Project"`	プロジェクト名またはプログラム名を記述する
◎	`OUTPUT_LANGUAGE`	`Japanese`	日本語出力する
◎	`OPTIMIZE_OUTPUT_FOR_C`	`YES`	C/C++言語ではYESに設定
	`PROJECT_NUMBER`	`1.1`	バージョン情報が必要であれば記述する
	`RECURSIVE`	`NO` or `YES`	`YES`にするとDoxygen実行ディレクトリ以下を再帰的に探してドキュメントを生成する
	`GENERATE_LATEX`	`NO`	LaTeX出力をしない（時間がかかるので、通常は抑制し、必要時にYESにする）
	`HAVE_DOT`	`NO`	graphvizを使用しない（時間がかかるので、通常は抑制し、必要時にYESにする）

以下の ファイル，グローバル関数，グローバル変数，来歴のコメントについては最低限記述する。doxygen コマンド実行でドキュメントを生成する。

工事中