Doxygen @ ウィキ
http://w.atwiki.jp/doxygen/
Doxygen @ ウィキ
ja
2014-03-11T12:09:29+09:00
1394507369
-
トップページ
https://w.atwiki.jp/doxygen/pages/1.html
// コメントアウトのテスト
***Doxygen@wikiへようこそ
このウィキはDoxygenとGraphvizの説明をするサイトです。
***Doxygenとは
Doxygenとは、複数の開発言語に対応しているドキュメント生成ツールです。
***このサイトの情報は、これらのサイトの情報を参考に作られています。
Doxygen関連
-[[Doxygen>http://www.stack.nl/~dimitri/doxygen/]]の本家サイト(英語)
-[[takagi.in - 高木信尚ホームページ>http://takagi.in/]]様コンテンツ内[[Doxygen翻訳サイト>http://www.doxygen.jp/]]より
Graphviz関連
-[[Graphviz>http://www.graphviz.org/]]の本家サイト(英語)
-[[気の向くままにプログラミング>http://homepage3.nifty.com/kaku-chan/index.html]]様コンテンツ内[[Graphviz チュートリアル>http://homepage3.nifty.com/kaku-chan/graphviz/index.html]]より
Doxygen&Graphviz共通
-[[Project D.E.V,AQUASPACE,そのたもろもろ 総合入り口>http://www.geocities.co.jp/project_dev/]]様コンテンツ内プログラムメモ内の[[doxygenのメモ >http://hp.vector.co.jp/authors/VA014436/prg_memo/index.html]]より
-[[uhaku @Wiki>http://www13.atwiki.jp/uhaku/]]様コンテンツ内[[Doxygen+Graphviz>http://www13.atwiki.jp/uhaku/pages/36.html]]より
HTML Help Workshop関連
-[[Hiroのホームページ>http://www5.ocn.ne.jp/~t-hiro/index.htm]]様コンテンツ内[[HTML HELP 徹底研究より>http://www5.ocn.ne.jp/~t-hiro/hhelp00.htm]]
-[[KeiYu HelpLab>http://www.keiyu.com/index.htm]]様コンテンツ内[[Q&A 操作編 エラーなど(KeiYu HelpLab)>http://www.keiyu.com/help/qa4.htm]]より
----
合計:&counter()
今日:&counter(today)
昨日:&counter(yesterday)
トップページの合計:&counter(total, page=トップページ)
このウィキの最終更新日時は&last_modified(j)です
----
//広告を消すためだけの更新2014/03/11
2014-03-11T12:09:29+09:00
1394507369
-
メニュー
https://w.atwiki.jp/doxygen/pages/2.html
***メニュー
-[[トップページ]]
-[[インストール]]
-[[Doxygenの使い方]]
//#google()
//-[[メニュー2]]
//-[[プラグイン紹介>プラグイン]]
//-[[まとめサイト作成支援ツール]]
----
**リンク
-[[@wiki>>http://atwiki.jp]]
-[[@wikiご利用ガイド>>http://atwiki.jp/guide/]]
**他のサービス
-[[無料ホームページ作成>>http://atpages.jp]]
-[[無料ブログ作成>>http://atword.jp]]
-[[2ch型掲示板レンタル>>http://atchs.jp]]
-[[無料掲示板レンタル>>http://atbbs.jp]]
-[[お絵かきレンタル>>http://atpaint.jp/]]
-[[無料ソーシャルプロフ>>http://sns.atfb.jp/]]
// リンクを張るには "[" 2つで文字列を括ります。
// ">" の左側に文字、右側にURLを記述するとリンクになります
//**更新履歴
//#recent(20)
&link_editmenu(text=ここを編集)
2009-01-30T17:20:07+09:00
1233303607
-
Graphviz ダウンロード
https://w.atwiki.jp/doxygen/pages/20.html
***Graphvizのダウンロード
1. まず、[[こちら>http://www.graphviz.org/]]のGraphviz本家サイト様より最新版のGraphviz本体をダウンロードしてください。
2. サイトの左側のAboutメニューにある[ Download ]より、次のページに行きます。
#image(Graphviz_Download-1.gif)
3. 利用規約をよく読み、よく理解してからページ最下部にある、[ Agree ]と[ Disagree ]の2つの内、[ Agree ]を選択して次のページに行きます。
( ちなみに、一度[ Agree ]を選択すると、Cookieを削除しない限り次回以降そのページに行かずにその先のページまで行くようになります。 )
#image(Graphviz_Download-2.gif)
4. そして、[ Executable Packages from AT&T ]の[ Windows ]項目にある、[ Stable and development Windows Install packages ]を選択します。
#image(Graphviz_Download-3.gif)
5. 最後に、[ graphviz-2.20.3.msi ]をダウンロードして終わりです。
#image(Graphviz_Download-4.gif)
6. ダウンロードが終わりましたら、次は[[こちら>Graphviz インストール]]をご覧ください。
----
***このページの参考にさせていただいたサイト
-[[takagi.in - 高木信尚ホームページ>http://takagi.in/]]様コンテンツ内[[Doxygen翻訳サイト>http://www.doxygen.jp/]]より
-[[uhaku @Wiki>http://www13.atwiki.jp/uhaku/]]様コンテンツ内[[Doxygen+Graphviz>http://www13.atwiki.jp/uhaku/pages/36.html]]より
2009-01-30T17:03:21+09:00
1233302601
-
Doxygenの使い方
https://w.atwiki.jp/doxygen/pages/19.html
***Doxywizardの設定方法
ここでは、Doxywizardの設定を行います。
詳しくは[[こちら>Doxywizard 設定]]をご覧ください。
***Doxygenの使い方
コメントの書き方は[[こちら>Doxygen コメント]]をご覧ください
----
***このページの参考にさせていただいたサイト
-[[Doxygen>http://www.stack.nl/~dimitri/doxygen/]]の本家サイト(英語)
-[[takagi.in - 高木信尚ホームページ>http://takagi.in/]]様コンテンツ内[[Doxygen翻訳サイト>http://www.doxygen.jp/]]より
2009-01-29T20:09:32+09:00
1233227372
-
HTML Help Workshop インストール
https://w.atwiki.jp/doxygen/pages/49.html
***インストールする順番について
インストールする順番は[htmlhelp.exe]を先にインストールしてから、[htmlhelpj.exe]をインストールして下さい。
***HTML Help Workshopのインストール方法
インストール方法はDoxygen同様に、[[ダウンロード>HTML Help Workshop ダウンロード]]したexeファイルを実行することでインストールが開始されます。
***用意するファイル
HTML Help Workshop本体のexeファイル(htmlhelp.exe)
***インストールの手順
1. ダウンロードしたexeファイルを起動してください。
利用規約をよく読み、[ Yes ]を選択してください。
#image(HTML Help Workshop Install 1.gif)
2. HTML Help Workshop 1.3をインストールするかを聞かれるので、そのまま[ Yes ]を選択してください。
#image(HTML Help Workshop Install 2.gif)
3. インストール先の選択画面が表示されます。
インストール先について特に問題なければそのまま[ OK ]を選択してください。
#image(HTML Help Workshop Install 3.gif)
4. インストール先の確認(?)的な事を聞かれているので、何も問題なければこのまま[ はい ]を選択してください。
#image(HTML Help Workshop Install 4.gif)
5. 最新版のHTML Helpが入っていました(?)的な事がいわれているだけなので、そのまま[ OK ]を選択してください。
#image(HTML Help Workshop Install 5.gif)
6. 最後にHTML Help Workshopのインストールが完了したといっているので、このまま[ OK ]をおして完了してください。
これでHTML Help Workshop本体のインストールは完了です。
#image(HTML Help Workshop Install 6.gif)
----
***日本語Helpのインストール方法
インストール方法は、上記と同じくダウンロードしたexeファイルを選択してください。
***用意するファイル
日本語Helpのexeファイル(htmlhelpj.exe)
***インストールの手順
1. 特に問題なければ、このまま[ OK ]を選択してください。
#image(HTML Help Workshop 日本語 Install 1.gif)
2. このまま[ Unzip ]を選択してください。
#image(HTML Help Workshop 日本語 Install 2.gif)
3. 以上で日本語Helpのインストールは完了です。
#image(HTML Help Workshop 日本語 Install 3.gif)
***注意
[.hhp]ファイルをHTML Help Workshopで読み込ませる前に、[.hhc]ファイルをテキストエディタなどで開いて、[SJIS]で保存し直して下さい。
そうしないと、生成されたHelpファイルの目次の所が文字化けをしてしまうのでそれを避けるために、、文字コードを[SJIS]にして保存し直して下さい。
----
***このページの参考にさせていただいたサイト
-[[Hiroのホームページ>http://www5.ocn.ne.jp/~t-hiro/index.htm]]様コンテンツ内[[HTML HELP 徹底研究より>http://www5.ocn.ne.jp/~t-hiro/hhelp00.htm]]
-[[KeiYu HelpLab>http://www.keiyu.com/index.htm]]様コンテンツ内[[Q&A 操作編 エラーなど(KeiYu HelpLab)>http://www.keiyu.com/help/qa4.htm]]より
2009-01-29T20:08:45+09:00
1233227325
-
HTML Help Workshop ダウンロード
https://w.atwiki.jp/doxygen/pages/48.html
***HTML Help Workshopのダウンロード
1. まず、[[こちら>http://msdn.microsoft.com/en-us/library/ms669985.aspx]]から最新版のHTML Help Workshop本体と日本語Helpをダウンロードしてください。
#image(HTML Help Workshop Download.gif)
2. ダウンロードが終わりましたら、次は[[こちら>HTML Help Workshop インストール]]をご覧ください。
----
***このページの参考にさせていただいたサイト
-[[Hiroのホームページ>http://www5.ocn.ne.jp/~t-hiro/index.htm]]様コンテンツ内[[HTML HELP 徹底研究より>http://www5.ocn.ne.jp/~t-hiro/hhelp00.htm]]
2009-01-29T20:04:08+09:00
1233227048
-
Graphviz インストール
https://w.atwiki.jp/doxygen/pages/21.html
***Graphvizのインストール方法
インストール方法はDoxygen同様に、[[ダウンロード>Graphviz ダウンロード]]したmsiファイルを実行することでインストールが開始されます。
***用意するファイル
Graphviz本体のmsiファイル
( 2009 01/14時点での最新版はGraphviz-2.20.3.msiです。 )
***インストールの手順
1. ダウンロードしたmsiファイルを起動してください。
[ Next> ]を選択してください。
#image(Graphvizインストール-1.gif)
2. インストール先の選択とGraphvizを使用するユーザーの設定画面が表示されます。
インストール先について特に問題なければそのままにしてください。
使用ユーザーの設定については、自分のアカウント以外のユーザーとGraphvizを共有して使う場合は[ Everyone> ]を選択してから、[ Next> ]を選択してください。
#image(Graphvizインストール-2.gif)
3. 最後に[ Close ]を選択してGraphvizのインストールは完了です。
#image(Graphvizインストール-3.gif)
----
***Graphvizの使い方
Doxygenと併用するので、操作する必要はありません。
----
***このページの参考にさせていただいたサイト
-[[uhaku @Wiki>http://www13.atwiki.jp/uhaku/]]様コンテンツ内[[Doxygen+Graphviz>http://www13.atwiki.jp/uhaku/pages/36.html]]より
2009-01-29T19:55:26+09:00
1233226526
-
インストール
https://w.atwiki.jp/doxygen/pages/13.html
***Doxygenのダウンロード
こちらの[[Doxygen本家サイト>http://www.stack.nl/~dimitri/doxygen/]]様より最新版のDoxygen本体をダウンロードしてください。
英語のサイトなので分かりづらいかもしれません。ダウンロード手順は[[こちら>Doxygen ダウンロード]]。
----
***併用できるツールについて
ここでは、Doxygenで出来る事がさらに広がるツールについて説明します。
***Graphviz
&size(13){&bold(){&color(#202f55){Graphvizとは}}}
&tooltip(DOT言語){Graphviz(Graph Visualization Software);グラフ描画プログラムで使用される、グラフ記述言語。}で書かれたグラフ表現からGIF や PNG などの画像ファイルに変換して作成するツールです。
このツールは、Doxygenと組み合わせることで、APIリファレンスにクラス図を付けたり、関数の呼び出しグラフを付けることが出来るようになる便利なツールです。
こちらの[[Graphviz本家サイト>http://www.graphviz.org/]]様より最新版のGraphviz本体をダウンロードしてください。
Doxygen同様、英語のサイトなのでダウンロード手順は[[こちら>Graphviz ダウンロード]]をご覧ください。
Graphvizのインストール方法については[[こちら>Graphviz インストール]]をご覧ください。
***HTML Help Workshop
このツールは、[[Doxywizard Wizardタブ設定>Doxywizard Wizardタブ設定]]のところにある、Output セクションの[prepare for complessed HTML (.chm)]にチェックをし、出力された[.hhp]ファイルをHTML Help Workshopに読み込ませて、出力させると、[.chm]形式のHelpファイルが生成されます。
ダウンロードは、こちらのMicrosoft様の[[Microsoft HTML Help Downloads>http://msdn.microsoft.com/en-us/library/ms669985.aspx]]より日本語版のHelpと共にダウンロードしてください。
ダウンロード手順は[[こちら>HTML Help Workshop ダウンロード]]をご覧ください。
HTML Help Workshopのインストール方法については[[こちら>HTML Help Workshop インストール]]をご覧ください。
ちなみに、DoxygenはGraphvizとHTML Help Workshopが無くても、動作自体にはまったく問題ありません。
----
***Doxygenのインストール方法
インストール方法はとても簡単で、ダウンロードしたexeファイルを実行することでインストールが開始されます。
***用意するファイル
Doxygen本体のexeファイル
( 2009 01/14時点での最新版はdoxygen-1.5.8-setup.exeです。 )
***インストールの手順
1. ダウンロードしたexeファイルを起動してください。
[ Next> ]を選択してください。
#image(Doxygenインストール-1.gif)
2. ライセンス規約画面が表示されます。
よく読んでから[ I accept the agreement ]を選択してから、[ Next> ]を選択してください。
#image(Doxygenインストール-2.gif)
3. インストール先の選択画面が表示されます。
特に問題なければそのままにして、[ Next> ]を選択してください。
#image(Doxygenインストール-3.gif)
4. インストール内容の選択画面が表示されます。
こちらも特に問題なければ、[ Full Installation ]のまま[ Next> ]を選択してください。
#image(Doxygenインストール-4.gif)
5. スタートメニューフォルダの選択画面が表示されます。
デフォルトの[ doxygen ]で問題ないと思います。[ Next> ]を選択してください。
#image(Doxygenインストール-5.gif)
6. インストール確認画面が表示されます。
自分が選択したものが表示されている事を確認後、[ Install ]を選択してください。
#image(Doxygenインストール-6.gif)
7. インフォメーション画面が表示されます。
[ Next> ]を選択してください。
#image(Doxygenインストール-7.gif)
8. 最後に[ Finish ]を選択してDoxygenのインストールは完了です。
#image(Doxygenインストール-8.gif)
----
***このページの参考にさせていただいたサイト
Doxygen関連
-[[uhaku @Wiki>http://www13.atwiki.jp/uhaku/]]様コンテンツ内[[Doxygen+Graphviz>http://www13.atwiki.jp/uhaku/pages/36.html]]より
Graphviz関連
-[[SourceForge.JP Open Source Software (オープンソース ソフトウェア)>http://sourceforge.jp/]]様コンテンツ内[[DOT言語>http://sourceforge.jp/projects/make-flowchart/wiki/DOT%E8%A8%80%E8%AA%9E]]より
HTML Help Workshop関連
-[[Hiroのホームページ>http://www5.ocn.ne.jp/~t-hiro/index.htm]]様コンテンツ内[[HTML HELP 徹底研究より>http://www5.ocn.ne.jp/~t-hiro/hhelp00.htm]]
2009-01-29T19:45:56+09:00
1233225956
-
Doxygen コメント
https://w.atwiki.jp/doxygen/pages/26.html
***Doxygen コメント
現在製作中
[[Doxygen コメント記述方法 1>Doxygen コメント記述方法 1]]
[[Doxygen コメント記述方法 2>Doxygen コメント記述方法 2]]
[[Doxygen コメント記述方法 3>Doxygen コメント記述方法 3]]
2009-01-29T17:20:15+09:00
1233217215
-
Expertタブ Buildtセクション設定
https://w.atwiki.jp/doxygen/pages/32.html
// 今後の予定
// 1. そのまま転載になっているものの修正
// 2. まだ翻訳出来ていない所の翻訳
***Buildtセクションでの設定内容
Buildtセクション
EXTRACT_ALL
全て抽出
(ソースにドキュメントがなくてもドキュメント内の要素は
全てドキュメント生成するする場合にチェック)
EXTRACT_PRIVATE
privateを抽出
EXTRACT_STATIC
staticを抽出
EXTRACT_LOCAL_CLASS
ローカルクラス(インナクラス?)を抽出
EXTRACT_LOCAL_METHOD
ローカル関数を抽出
EXTRACT_ANON_NSPACES
ここが設定されると、anonymous namespaceのメンバーが抽出され、
ドキュメントに表示されます。
デフォルトではanonymous namespaceは隠れています。
HIDE_UNDOC_MEMBERS
ドキュメント化されていないメンバを隠す
HIDE_UNDOC_CLASSES
ドキュメント化されていないクラスを隠す
HIDE_FRIEND_COMPOUNDS
このタグを設定すれば、friend (クラス、構造体、共用体)宣言は
すべて隠される。
デフォルトであれば、これら宣言は文書に出力されます。
HIDE_IN_BODY_DOCS
このタグが設定してあると、関数本体の内部で見つかった文書ブロックは
すべて隠されます。
デフォルトであれば、これらブロックは関数の詳細文書ブロックに追加する。
INTERNAL_DOCS
このタグは、\internalコマンドに続く文書を出力するか否かを決定する。
デフォルトであれば、文書は除外される。
internal 文書を出力するのであれば、設定してする。
CASE_SCENE_NAMES
大文字・小文字の区別をしてドキュメントを生成
HIDE_SCOPE_NAMES
スコープ名を隠す
(クラスと名前空間のスコープをドキュメントに記載しない場合にチェック)
SHOW_INCLUDE_FILES
インクルードファイルを表示する
INLINE_INFO
インライン情報
SORT_MEMBER_DOCS
メンバをソートする
SORT_BRIEF_DOCS
クラスのメンバをアルファベット順にソートして記載する場合にチェック
SORT_GROUP_NAMES
ここがYESに設定されると、グループ名の階層をアルファベット順に
並び替えます。
NO(デフォルト)だと、グループ名は定義された順序で表示されます。
SORT_BY_SCOPE_NAME
スコープ名でソート
GENERATE_TODOLIST
ToDoリストを作成
(やることリストを記載する場合にチェック)
GENERATE_TESTLIST
テストリストを作成
GENERATE_BUGLIST
バグリストを作成
GENERATE_DEPRECATEDLIST
推奨されないリストを記載する場合にチェック
ENABLE_SECTIONS
条件付きドキュメンテーションを有効にすることができます。
MAX_INITALIZER_LINE
変数やdefineの初期値がとれる最大の行数を決定する。
初期化子の行数が指定行数より多いと、出力されない。
初期化子を完全に隠すには、このタグを 0 にする。
変数や define の個々の値の出力は、\showinitializer コマンドや、
\hideinitializer コマンドを文書に使うことで制御できる。
SHOW_USE_FILE
利用しているファイルを表示
(クラスのドキュメントにおいて元ととなったソースファイルを
記載する場合にチェック)
SHOW_DIRECTORES
ディレクトリを表示
(プロジェクトのソース階層が記載する場合にチェック)
SHOW_FILES
Filesページの生成を抑制するときは、NOにしてください。
フォルダのツリー表示をさせるときは、YES(デフォルト)にしてください。
SHOW_NAMESPACES
NOに設定すると、Namespacesページの生成を無効にします。
これは、クイックIndexからNamespacesエントリとフォルダの
ツリー表示を表示させないようにする設定です。
デフォルトはYESです。
FILE_VERSION_FILTER
(大抵はバージョン制御システムから)各ファイルの現バージョンを
取得しようとするプログラムやスクリプトを指定するのに使う。
doxygenは、command input-fileコマンドを(popen() を介して)
実行してプログラムを起動します。
commandはこのタグの値で、input-fileはdoxygenが提供する
入力ファイル名です。
プログラムが標準出力に書き込むものが、ファイルバージョンとして
使われます。
LAYOUT_FILE
Doxygenで出力されるファイルのレイアウトを指定するために使用します。
doxygenのデフォルトレイアウトファイルは、[DoxygenLayout.xml]です。
ちなみに、ファイル名を任意に指定することができます。
----
***このページの参考にさせていただいたサイト
Doxygen関連
-[[Doxygen>http://www.stack.nl/~dimitri/doxygen/]]の本家サイト(英語)
-[[takagi.in - 高木信尚ホームページ>http://takagi.in/]]様コンテンツ内[[Doxygen翻訳サイト>http://www.doxygen.jp/]]より
-[[Project D.E.V,AQUASPACE,そのたもろもろ 総合入り口>http://www.geocities.co.jp/project_dev/]]様コンテンツ内プログラムメモ内の[[doxygenのメモ >http://hp.vector.co.jp/authors/VA014436/prg_memo/index.html]]より
-[[uhaku @Wiki>http://www13.atwiki.jp/uhaku/]]様コンテンツ内[[Doxygen+Graphviz>http://www13.atwiki.jp/uhaku/pages/36.html]]より
----
2009-01-27T18:32:44+09:00
1233048764