新石器Wiki

近年はシリコン(石)から進化した便利なもので溢れる時代。そんな気になった事や試した事など記す。

ユーザ用ツール

サイト用ツール


サイドバー

Home The modern stone age.

サイドバー

記事ナビ


タグ一覧

タグ#
1
18
5
2

作者関連サイト

参考

スポンサーリンク

programing:doxygen:doxygen-coding-rules-c


Doxygen記述ルール

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

Doxygen文法マニュアル

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 コマンド実行でドキュメントを生成する。

FIXME 工事中

programing/doxygen/doxygen-coding-rules-c.txt · 最終更新: 2020/02/27 10:49 by yoko