新石器Wiki

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

現在位置: 新石器Wiki » プログラミング » Doxygen

トレース:

programing:doxygen:start

差分

このページの2つのバージョン間の差分を表示します。

この比較画面へのリンク

--- programing:doxygen:start [2020/02/20 09:11] – yoko
+++ programing:doxygen:start [2026/07/28 13:16] (現在) – 外部編集 127.0.0.1
@@ 行 1: / 行 1: @@
-Doxygen
+====== Doxygen ======
-=======
 [[http://www.doxygen.jp/|Doxygen]]はソースファイルのコメントから文書を抜き出してドキュメント化するツール。
 Doxygenに関する情報を、本ページを起点に作成していく。
-FIXME 工事中
+  * [[doxygen-coding-rules-c]]
-インストール手順
+===== インストール手順 =====
----------------
 姉妹サイトの下記の記事を参照。
-  * [[https://www.yokoweb.net/2020/02/18/macos-doxygen-install/|【macOS】Doxygenをインストールして使う]]
+  * [[myblog>2020/06/29/ubuntu-linux-doxygen-install/|【Ubuntu Linux】Doxygenをインストールして使う]]
+  * [[myblog>2020/02/18/macos-doxygen-install/|【macOS】Doxygenをインストールして使う]]
+  * [[myblog>2020/02/21/msys2-doxygen-install/|【msys2】Doxygenをインストールして使う]]
+  * [[myblog>2020/03/01/windows-doxygen-install/|【Windows】Doxygenをインストールして使う]]
-参考
+===== Doxygen記述例 =====
-----
+コメント記述したサンプルソースを「[[https://github.com/jr4qpv/gcc_sample|GitHub]]」に登録しているので、参考にください。
+任意フォルダで下記コマンドで取得。
-. [[wpjp>Doxygen|Doxygen - Wikipedia]]
+<code bash>
+$ git clone https://github.com/jr4qpv/gcc_sample
+</code>
+取得した`gcc_sample`フォルダに移動して、`doxygen` コマンドを実行してドキュメント生成。
+<code bash>
+$ doxygen -g
+$ doxygen
+</code>
+### ドキュメント表示例
+上記のサンプルでドキュメントのHTML表示例。
+{{:programing:doxygen:doxygen-sample-01.png?700|}}
+`Files`リストの、`sample.c` をクリック。
+{{:programing:doxygen:doxygen-sample-02.png?700|}}
+===== 参考 =====
+  - [[wpjp>Doxygen|Doxygen - Wikipedia]]

programing/doxygen/start.1582157497.txt.gz · 最終更新: 2020/02/20 09:11 by yoko