Doxygen
ソースコード・ドキュメンテーション・ツール Doxygen は、C++、C、Java、Objective-C、Python、IDL (Corba、Microsoft 風)、Fortran、VHDL、PHP、C# 向けのドキュメンテーション・システムです。 D にもある程度対応しています。 Doxygen には、次の３つの利点があります。 文書化されたソースファイルのセットから、 オンライン・ドキュメント・ブラウザ (HTML形式) やオフラインのリファレンス・マニュアル (形式) を生成することができます。 RTF (MS-Word)、PostScript、ハイパーリンク PDF、圧縮 HTML、Unix man ページ形式の出力もサポートされています。ドキュメントは、ソースから直接抽出されます。これにより、ドキュメントとソースコードの一貫性を保つことがとても容易になります。 Doxyge
Let’s use doxygen!
はじめに プログラマには、ドキュメント、とくにプログラムの内部仕様書を書くのが苦手、 という人が多い。 その理由は明らかであって、そもそも、ソースコードに (バグも含めて)*1 すべての仕様が子細もらさず書かれているのに、なぜ、さらにそれと独立した仕様書が必要なのかと、 (半ば本気で) 思ってしまうからである。 ソースコードと独立にメンテナンスをしなければならないような仕様書は、 いずれソースコードと整合性が取れなくなって、無意味ならまだしも、 かえって害をなす存在となり果てることもある、ということを、 彼らは経験的に理解しているのである。 (*1) Ruby の作者である、まつもとゆきひろ氏は、 その著者『オブジェクト指向スクリプト言語 Ruby』の中の「付録C Ruby 用語集」で、 次のように書いている: ドキュメント まつもとの苦手なもの。彼は普段から「ソースがドキュメントだ。
はじめに お客様に提案をしているときの会話です。 お客様：「詳細設計書は作りますか」 私：「昔ながらの詳細設計（ロジックを日本語で書くもの）は作りません。クラス図とか、シーケンス図は複雑であれば作りますが、今回のシステムはそこまで必要なものはないものなので、割愛しようと思っています。」 お客様：「保守をお願いするかどうか未定なので、場合によっては引継ぎのために作ってもらうかもしれません」 私：「・・・・」 といった感じで、私がこの業界に入った30年前は、確かにプログラムを作る前に、詳細設計書と呼ばれるプログラムを日本語で書いていました。 最近、詳細設計と呼ばれるものを作った記憶がなく、無駄なものは作りたくないなぁという思いから、コードから自動生成できないかなと思って、いろいろ試してみました。 Doxygenって いろいろ調べてみると、Doxygen にたどり着きました。 色々な言語に対応し
Doxygen: Main Page
Generate documentation from source code Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D. Doxygen can help you in three ways: It can generate an on-line docu
日頃より楽天のサービスをご利用いただきましてありがとうございます。 サービスをご利用いただいておりますところ大変申し訳ございませんが、現在、緊急メンテナンスを行わせていただいております。 お客様には、緊急のメンテナンスにより、ご迷惑をおかけしており、誠に申し訳ございません。 メンテナンスが終了次第、サービスを復旧いたしますので、 今しばらくお待ちいただけますよう、お願い申し上げます。
Doxygen マニュアル
Doxygen マニュアル このマニュアルは 3つのパートに分かれています。 それぞれのパートは、さらにいくつかのセクションに分かれます。 パート 1 は、ユーザー・マニュアルです。 セクション インストール では、 ダウンロード、コンパイル、 インストールの方法を説明します。 セクション はじめよう では、最初のドキュメントを素早く生成する方法を説明します。 セクション コードのドキュメント付け では、コードにドキュメントを付けるための様々な方法を例示します。 セクション リスト では、リストを作成する様々な方法を示します。 セクション グループ化 では、グループ化の方法を示します。 セクション 式のインクルード では、ドキュメントに式を挿入する方法を示します。 セクション グラフと図 では、Doxygen で生成できる図とグラフを説明します。 セクション プリプロセス では、Doxyg
Doxygen: Main Page
Generate documentation from source code Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D. Doxygen can help you in three ways: It can generate an on-line docu
doxygen用コメントの書き方
コメントの書き方(クラス・関数のコメント) このページの最新版は以下の場所をご覧くださいhttp://sakura-editor.wiki.sourceforge.net/DoxygenComment ソースコード中のコメントをdoxygenの 解説に反映させるためのコメントの書き方です。新規にコメントを入れる場合は以下のルールにできるだけ従うようにしてください。 関数内のコメントはこのルールに従っていただいても意味がありません ので通常のコメントで結構です。ドキュメント生成に関係するのは、 ファイル クラス メンバー関数（Inline含む） メンバー変数 グローバル変数 クラスのメンバーでない関数 定数宣言 (#define, enum) です。 doxygenで認識されるコメント スタイル doxygenではQtスタイル及びJavaDocスタイルのコメン トを認識します．コメントには要
卒論生成たけなわの皆さんお疲れ様です。終わった皆さんお疲れ様です。 卒論ページを埋めるためにクラス図を生成する必要がありましたので、メモです。 暇になったら加筆します。 クラス図とかソースコードの依存関係の図を自動生成したい ソースコードが先にあってUMLを作るためのツールは探すと有料がほとんど。 でもDoxygenとGraphvizを組み合わせると無料でできるらしい。 というわけで用意するものはDoxygenとGraphvizとソースコードです。C++、C、Java、Objective-C、Python、IDL、 PHP、C#、Dに対応しているそうです。 まずGraphvizとDoxygenを下記からインストールします。 Graphviz | Graphviz - Graph Visualization Software Doxygen すべてデフォルトでOK Doxygenの設定 楽天
Doxygen：コードのドキュメント付け
コードのドキュメント付け 特殊ドキュメント・ブロック 特殊ドキュメント・ブロックは、C または C++スタイルのコメントブロックにマークを付け加えたもので、Doxygenはこれをドキュメント断片と認識して、ドキュメントを生成します。 PythonとVHDLコードについては、別のコメント表記規則があります。セクションPython での特殊ドキュメント・ブロック と VHDL での特殊ドキュメント・ブロック で説明します。 各コード要素について、説明形式が2（3の場合も）種類あり、これらがドキュメントを形成します。それは、要約説明と 詳細説明で、どちらもオプションです。メソッドと関数については、もうひとつの形式があり、いわゆる"本文内"説明で、メソッドや関数の本体内のコメントブロックの連結からなります。 ひとつ以上の要約説明または詳細説明を指定できます。（ただし、出現順序が指定されていないため
Doxygen - 特殊コマンド
特殊コマンド はじめに ドキュメント内のすべてのコマンドは、バックスラッシュ (\)、 またはアットマーク (@) で始まります。 お望みであれば、以下のバックスラッシュで始まるすべてのコマンドを、 それに対応したアットマークで始まるものに置き換えることができます。 いくつかのコマンドは、1つまたはそれ以上の引数を取ります。 各引数には、ある決まった範囲があります: <山> 括弧が使われている場合、引数は 1単語からなります。 (丸) 括弧が使われている場合、引数は、コマンドのある場所からその行の終わりまでとなります。 {波} 括弧が使われている場合、引数は、次のパラグラフの頭までとなります。 パラグラフは、空行かセクション指示子で区切られます。 [角] 括弧が使われている場合、引数は省略可能です。 以下は、全コマンドをアルファベット順に整列したリストです (説明への参照付き)。
doxygen 日本語訳
Doxygen ライセンス Copyright © 1997-2001 by Dimitri van Heesch. Copyright © 2001 by OKA Toshiyuki (日本語訳) Permission to use, copy, modify, and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. Se
電八開発倶楽部 - Doxygenコメント
コメントの義務 他のコメント同様doxygenコメントも義務ではありません。コメントを付けようと思うとき、doxygenコメントにすることも義務ではありません。普通のコメントが付いていれば誰かがdoxygen形式に直します。たぶん。 ただし、コメントを付けるときにDoxygenコメントに配慮することは義務です。doxygenコメントは以下のコメント書式で始まりますので、ドキュメントに出力される必要の無いコメントはこのコメント書式を避けてください。 /** /*! //! /// Doxygenコメントの書き方 以下では、doxygenコメントの電八ソースにおけるルールを示します。つまり、doxygen自体の使い方は主眼ではないです。より良いルールに改訂するためにご意見をお待ちしています。 doxygenは割とメジャーなツールなので、使い方自体はウェブ上に大量の参考になるページがあります。使
Doxygen
設定 フォーマット 設定ファイルは、Makefile に似た構造を持つ、自由形式の ASCII テキストファイルで、デフォルトでは Doxyfile という名前になります。 ファイルは、doxygen によって解析されます。 書式設定のため、タブや改行コードを入れられます。 ステートメントは、大文字と小文字が区別されます。 ファイル内のどこにでもコメントを置くことができます (クォートの中を除く)。 コメントは、# 文字で始まり、行の終わりまで続きます。 ファイルは、本質的には、代入文のリストからなっています。 各ステートメントは、大文字で書かれた TAG_NAME の後に = 文字と1つ以上の値が続いたものです。 同じタグへの代入が 2回以上現れた場合は、最後の代入文だけが有効になります。 引数にリストを指定するオプションについては、= のかわりに += 演算子を使って、リストに新しい値
doxygenのメモ
はじめに インストール 使い方 Wizardボタンでの設定内容 Expertボタンでの設定内容 ドキュメント化 @author @brief @ef @example @date @note @sa @param @return @retval @file @mainpage @attention @deprecated @exception/@throw @par @version 参考 はじめに doxygenはC/C++/Javaのソースを解析し、ドキュメントを生成するツールです。 簡単に言ってしまえば、JavaDocと同じようなものです。 doxygenとGraphvizを組み合わせると、UMLの図もドキュメントに組み込まれます。 doxygenもGraphvizもいろいろなプラットフォームのバイナリが提供されています。 doxygenとGraphvizは下記のサイトから入
github pages をつかうと簡単に HTML のページを公開できる。Doxygen をつかうと簡単に HTML のドキュメントを生成できる。ってことは、この2つを簡単にくみあわせられれば最強じゃね? ということでやってみた。 gh-pages branch の生成はいつものようにおこなう。 $ git symbolic-ref HEAD refs/heads/gh-pages $ rm .git/index $ git clean -fdxそしたら、master にもどして、gh-pages branch を docs/ という名前で submodule にする $ git co master $ git submodule add -b gh-pages `git remote -v|grep origin|awk '{print$2}'` docsdoxygen の設定ファイル
Doxygen 高機能なんだけど、高機能すぎてどうやって Doxygen 用のコメントを書けばいいのかよくわからん。コメントとルール作りも兼ねてテンプレートを作っておこう。 Doxygen のいいところはソースコードが可視化されることもあるけど、コメントを付けてないとソースコード解析時に「コメントが付いとらん」と警告してくれるところ。さぼってコメントを付けないのを防いでくれる。 Doxygen C/C++ テンプレート comment.c /**********************/ /* ファイルヘッダの例 */ /**********************/ /******************************************************************************/ /*! @addtogroup モジュール名_サブモジュール名
doxygen 設定
フォーマット 設定ファイルは、Makefile に似た構造を持つ、 自由形式の ASCII テキストファイルで、デフォルトでは Doxyfile という名前になります。 ファイルは、doxygen によって解析されます。 見た目を整えるために、タブや改行コードを含むこともできます。 「文」は、大文字・小文字が区別されます。 ファイル内のどこにでもコメントを置くことができます (クォートの中を除く)。 コメントは、# 文字で始まり、行の終わりまで続きます。 ファイルは、本質的には、代入文のリストからなっています。 各々の文は、大文字で書かれた TAG_NAME の後に = 文字と1つ以上の値が続いたものです。 同じタグへの代入が 2回以上現れた場合は、最後の代入文だけが有効になります。 引数としてリストをとるオプションに対しては、= のかわりに += 演算子を使って、リストに新しい値を追加す
オープンソースのソフトウェアはソースコードを読むことができるのが大きな魅力ですが、大規模なプロジェクトでは全体を見通すのに時間がかかってしまいます。そんなとき、C++のプロジェクトにはdoxygenとgraphvizを使ってソースコードからドキュメントを自動生成することができます。doxygenは、元々はJavaのJavadocを参考にC++のソースコードを解析しているので、継承関係や包含関係などのオブジェクト指向な構造を可視化するのに向いています。本来なら専用のフォーマットに従ってコメントを入れておくとドキュメントに含めてくれるのですが、ソースコードリーディングの補助として使う場合には気にしなくて構いません。DoxygenHome | Graphviz - Graph Visualization Software インストール CentOSyumを使うsudo yum install g
大きいプロジェクトだとクラスとかメソッドがいっぱいあって、それぞれ呼び出し合ったりして、もー意味わかんない。構造を視覚的に追えると良いんだけど、クラス図とかコールグラフを手作業で作ってると埒があかない。 ということで、自動でドキュメント + クラス図やコールグラフを作ってくれるツール Doxygen と Graphviz がとっても便利だったのでメモっておく。 とりあえず説明する上での環境は Mac OS X 10.7 + Homebrew ということで。Doxygen と Graphviz 自体は、UNIX 系の OS ならどれでも動かせるんだと思う。 まずは Homebrew からインストールする。 # brew install doxygen graphviz インストールできたら、解析したいソースコードのあるディレクトリで Doxygen を使う。今回解析するコードは Java だ
保守対象のC#のソースコードを都度々々一から解析してAstahのコミュニティ・エディションでこつこつUML化するのにはいい加減飽きてきたので、既存リソースからドキュメント生成するツールを探していました。 結果、DoxygenというJavaやC#やその他いろいろに対応した汎用ツールがあることを知り、実際に使用してみました。 使用するにあたり参考にしたのはこちらのサイトの以下の2つの記事です： doxygenを使用してC#のドキュメントを自動生成する(その1) doxygenを使用してC#のドキュメントを自動生成する(その2) 2年前の記事ということで、若干当時と状況が違うようでしたので、私が今回行った手順を以下にメモしておきます。 Doxygenの実行ファイルを取得 Doxygenの公式サイトにアクセス。［Doxygen］→［Downloads］と進んで、 「A binary distrib
【iPhone】【Three20】doxygenで神ライブラリのドキュメント生成してみた | iphoneアプリで稼げるのか
iPhoneのPhotoアプリ再現どころではない神ライブラリ見つけた | iphoneアプリで稼げるのか まだほとんどソースを見切れてないけど、とりあえず全体を流しみるためにも、doxygenを使ってドキュメント生成してみた。 Three20ドキュメント （このドキュメント先、一時的に借りてるサーバなので後でURL変わるかも） 神ライブラリ。ソース見ればみるほどすごいっす。 Photoビューア部分とかUIScrollViewをうまく使っているのかなと始めは思っていたのですが、UIViewから独自のTTScrollViewを１から作り込んでいたのですね。ん〜なるほどです。 全体的に見るとAppleが用意しているフレームワーク達と同じようなクラスを独自で作り込んでるっぽい。 ラベルとかビューもスタイルシートクラス用意してバチコンやってるとかすごいなぁ。 一部日本語が化けてしまうもの（TT
Doxygen の使いかた - アカベコマイリ
非常に便利なコード ドキュメント作成ツール、Doxygen についての覚え書き。 Doxygen とは？ Doxygen とはソースコード ドキュメンテーション ツールである。 Doxygen 本家 Doxygen 日本語サイト ソフトウェア開発をしていると新参メンバーや外部ユーザー向けの API リファレンスなどを求められる機会がわりとある。そんな時にコードやコメントを自動解析してドキュメント生成してくれると便利。Doxygen はそのような要求を叶えてくれる。 この種のツールでは Java の Javadoc や.NET の NDoc、Sandcastle などが有名。これらが特定のプログラミング言語やプラットフォームに最適化されているのに対して Doxygen は総合的・網羅的である。多数の言語に対応し Windows、Mac、Linux 上で動作する。 ドキュメントの出力形式も豊富
開発者の負担を減らす技術文書自動生成システム「Doxygen 1.5.0」 | エンタープライズ | マイコミジャーナル
ソースコードなどの技術文書を自動生成する「Droxygen 1.5.0」がリリース、Webサイト上でダウンロード提供が開始された。メジャーバージョンアップとしては、バージョン1.4.0が公開された2004年12月以来約1年10カ月ぶり。UNIX系OS汎用のソースコードのほか、Windows 95/98/Me/NT/2000/XPおよびMac OS Xに対応したバイナリが提供されている。 Doxygenは、オランダ在住のDimitri van Heesch氏が開発する文書自動作成システム。ソースコードに記述されたコメントを自動的に収集、技術仕様書としての体裁を整えたうえでドキュメント化する働きを持つ。生成可能な文書フォーマットは、HTMLとLaTeX、リッチテキスト(RTF)とXML、オンラインマニュアル(man)の5種類。ソースコード上で確認されたファイルのインクルードやクラスの派生の関係
新トップページへ ｜ Ｔｉｐ ソースコードからドキュメントをDoxygenで生成する LastUpdate : 13/01/02 JavaDoc的なことをC++でもやろう、という話です。 正直、JavaDocで生成したHTMLを見て役に立ったことがあまり有りませんが、コメントを書く際の統一的な書式としては役に立つと思います。 もくじ はじめに Doxygenのインストール コメントの書式 ドキュメントを生成する はじめに 詳細はこちら(http://www.doxygen.jp/)を参照。 日本語サイトがあるので、非常に便利です（すごい！）。また、非常に多機能。 実際、使えるようなドキュメントにするかしないかはコメントを書く人次第だが・・・。 このページでは、コメントの基本的な書き方をサンプルとしてあげる程度に留める。 また、Doxygenは、コメントの書式がいくつかのタイプから選べるが（
ecloxとdoxygenで仕様書メンテナンスの効率をUP！：生産性向上への道 Eclipseで行うC／C++開発（4）（1/4 ページ） 本連載では、組み込み開発に「Eclipse」を適用するメリットおよび適用方法の概要を紹介してきましたが、今回でいよいよ最終回となります。 第1回「組み込み開発におけるEclipseの有効性」では、EclipseのメリットやC／C++開発に利用できるプラグインの紹介をしました。第2回「『CDT』で効率的なC／C++開発を実現する」と第3回「CDT／RSEによるクロスコンパイルとリモートデバッグ」では、CDTとRSEを利用したC／C++アプリケーションの開発方法を紹介してきました。 最終回となる今回は「eclox」と「doxygen」を使ったドキュメントの自動生成について解説します。 今回の内容を読み進める前に、これまでの連載記事をもう一度読んでおくと、よ
Doxygen - Wikipedia
Doxygen（ドキシジェンまたはドクシジェン）は、C++、C言語、Java、Objective-C、Python、IDL（CORBAおよびマイクロソフト形式）のためのドキュメンテーションジェネレータである。他にもPHP、C#、D言語、ActionScriptでもある程度利用可能。多くのUnix系システム、Windows、macOSで動作する。Doxygenのコードの大部分は Dimitri van Heesch が書いた。 KDEは文書の一部にDoxygenを利用しており、KDevelopは組み込みでサポートしている。 概要[編集] Javadocのように、Doxygenはソースファイルのコメントから文書を抜き出す。Javadocの文法に加えて、Qtツールキットで使われるドキュメンテーションタグをサポートしており、HTML形式だけでなく、CHM、RTF、PDF、LaTeX、PostScr
コメントの書き方(クラス・関数のコメント) このページの最新版は以下の場所をご覧くださいhttp://sakura-editor.wiki.sourceforge.net/DoxygenComment ソースコード中のコメントをdoxygenの 解説に反映させるためのコメントの書き方です。新規にコメントを入れる場合は以下のルールにできるだけ従うようにしてください。 関数内のコメントはこのルールに従っていただいても意味がありません ので通常のコメントで結構です。ドキュメント生成に関係するのは、 ファイル クラス メンバー関数（Inline含む） メンバー変数 グローバル変数 クラスのメンバーでない関数 定数宣言 (#define, enum) です。 doxygenで認識されるコメント スタイル doxygenではQtスタイル及びJavaDocスタイルのコメン トを認識します．コメントには要
比較的規模の大きいソースコードを見る際、何らかの目的を持った上でソースコードを読み始める。 目的の粒度は大なれ小なれ「コードのどこに着目するか」という疑問は必ず生じる。 パズルも完成形の絵柄を知らずに組み立てるのと 予め出来上がった後の形を知った上で組み立てるのとで 完成の時間が変わってくるように、ソースコードもその全体の形ができるだけ見えた方が良い。 とはいえ、数千行～数万行のコードを相手に 自分の手で一つ一つのクラスの役割や関連性を整理するのも得策ではないので、ここは一つ先人の知恵を活用した方が良さそう。 ということで、今回はソースコードリーディングのお供として活躍してくれるドキュメント自動生成ツール「Doxygen」と、構造体やクラス間の関係を図で出力してくれる「Graphviz」を紹介。 プログラミングの勉強中に何かの本のサンプルコードを読み解く上でも十二分に力を発揮してくれるので
[要旨] doxygen と graphviz を組み合わせて使うと、クラス図やコラボレーション図などの絵を組み込むことができます。ただし、モジュールの名前が日本語の場合、文字化けしてしまって、実用になりません。その解決方法がわかりましたので、解説します。 [キーワード] 文字化け,ドキュメント,コメント
perl だって Doxygen が使いたい！
前投稿に引き続いて、自動的にperlソースからドキュメントを作ろう企画。 これは何ですか？ Doxygen は強力なドキュメンテーションツールです。 プログラム中に書かれた定義とかコメントとかを解析して、 美しい HTML にしてくれます。 これがあれば、詳細設計書はばっちり。 （設計書って作る前に書くんじゃ？という話はナシ） しかし、オリジナルの Doxygen は Perl には対応していません。 その代わり、perldoc とか Pdoc とかを使っていたわけですが、 なんつーか、イマヒトツな感が否めません。 そんな Perl に対応してくんないかなーと思っているアナタのために、 エライ人が filter を作ってくれました。 ・Doxygen ・Perl Doxygen Filter インストール Doxygen すらインストールされていなかったので、まずインストール。 RedHa
brew install doxygen graphviz doxygen -g; edit Doxyfile; doxygen; open html/index.html OSSなライブラリ、たとえばMGBox2の使い方を調べているときに、クラス図が欲しくなりました。 ソースを追っかけてノートに手書きするのも悪くないのですが、せっかくなのでソースから生成させてみました。 調べたところ doxygenとgraphvizの組み合わせがよさそうなので、この組み合わせをインストールしてクラス図を含むドキュメントを生成させます。 doxygenとgraphvizのインストール homebrewを使っていれば、brew install doxygen graphvizでインストール出来ます。 mba% brew install doxygen graphviz ==> Downloading htt
技術文書自動生成システム「Doxygen 1.5.8」 - ウィザードが改良 | エンタープライズ | マイコミジャーナル
Doxygen開発チームは27日 (米国時間)、開発者向け技術文書自動生成システム「Doxygen 1.5.8」をリリースした。動作環境はWindowsとMac OS X、およびLinux。ソースコードからビルドする場合には、Qt 4.3以降が必要。 今回のリリースでは、ウィザードなどGUIに使用するウィジェットをQt 4ベースに変更、ウィザードモードとエクスパートモードの切り替えが容易になったほか、出力したHTMLをプレビューするためのボタンが配置されるなど、操作性が向上した。新設のEXTENSION_MAPPINGオプションに定義することで、解析対象とするファイルの拡張子を任意に指定することが可能になった。 開発者向けドキュメント自動生成ツールの最新版「Doxygen 1.5.8」 (画面はMac OS X版)
Doxygen: Downloads
This page always contains a link to the latest version of doxygen. Be notified of updates This is a hidden list, which means that the members list is available only to the list administrator. You will be sent email requesting confirmation, to prevent others from gratuitously subscribing you. You must enter a privacy password. This provides only mild security, but should prevent others from messing
CentOS4/CentOS5：doxygenでUTF-8日本語PDFのドキュメントを出力する - Akio's Log
doxygenからUTF-8で日本語PDFファイルを作成する環境をCentOSに構築したのですが、予想以上にしんどい思いをしたので、まとめメモを作成しておきます。誰かの参考になれば幸いです。 背景 仕事で作ったプログラムの成果物のひとつとして、doxygenで出力したファイルを納品している。開発中は出力されたHTMLのままの方が何かと使い勝手も良いのだが、納品用のドキュメントとなると、PDFファイルとそれを印刷した紙のドキュメントが、やはりお客様には好まれるようだ。 doxygen自体は、導入してHTMLを出力させるだけであれば、簡単に使うことが出来る。graphvizをインストールすれば、関数の呼び出し関係やヘッダのインクルード関係など、ビジュアル的にも見栄えの良い図を生成することも出来る。ただし、PDFファイルへ出力しようとすると、日本語の処理でエラーが発生してしまい、うまく出力できな
Doxymacs is Doxygen + {X}Emacs. The purpose of the doxymacs project is to create a LISP package that will make using Doxygen from within {X}Emacs easier. Version 1.8.0, released 2007-06-10, has the following features: ability to look up documentation for symbols from {X}Emacs in the browser of your choice. easily insert Doxygen style comments into source. optionally use an "external" (i.e. written
世の中のプログラマは、基本的にものぐさだ。 (あ〜、言っておくが、カット＆コピーしまくるのは、ものぐさとは言わない。ありゃ、ロボットだと思う) コード作りには熱心になれても、ドキュメント作成になると一気に能率が落ちるのが常だ。 てな訳で、ソースコードからドキュメントを自動生成しようとする人達が現れる。自分の狭い知識では、 C/C++だと、doxygen Javaだと、JavaDoc Pythonだと、pydoc あたりが有名みたいだ。 で、題名にあるpythonで、(pydocがあるのに)何故わざわざdoxygenを使うのかって言うと、引数とか返値などを明示する書き方とか、それをドキュメント化する手段がないかな？と探した結果が コレ という訳。後、doxygenだと後で述べるように、様々な形式のドキュメントファイルを一気に出力できる所があるので。 引数とか返値とか何で細かく書きたいのか？っ
裏タグ[組込み][マイコン][V850] はじめに 前々からの懸案となっていたMicrOS(OSの癖に5000行とコンパクト)のソースコードリーディング。なんとなくやる気がおきない。それはなぜか？自己分析した結果、手持ちのエディタが秀丸だからという結論が出た。その詳細は省略して、"ソースコード 解析"とかで検索する。検索中に、ふと、リーマン時代に使ってたDoxygenを思い出す。Doxygenは、ソースコードに特殊コメントを埋め込んで、Doxygenをかまして、ドキュメントを生成するツール。そういえば、Doxygenはドキュメントだけでなく、ソースブラウザとして使えるじゃんと思い立つ。 インストール doxygen ダウンロード＆インストール。 doxygen-1.5.5-setup.exe graphviz ダウンロード＆インストール。 graphviz-2.16.1.exe Doxyg
以前の記事でC言語のソースコードを解析するためのVim環境を構築した。 C言語のソースコードを解析するため、Vimにプラグインを追加する - .logbook しかし、大規模なS/Wともなるとエディタだけでは解析に限界がある。そこで今回、ソースコードからドキュメントをリバース・エンジニアリングするためのツール「Doxygen」をインストールすることにした。 Windows版のDoygenであればGUIで設定ができるが、今回はあえてUbuntu上に環境を構築し、コンソールベースで設定することとした。 Doxygenのインストール 毎度お馴染み、apt-getでさくっとインストールする。 $ sudo apt-get install doxygen 今回はC言語のソースコードから関数のコールツリーを出力させたい。そこで、ドキュメント情報をコールツリー等の図表に変換するため、もう一つツールをイン
Doxygenコメント規約例
[ C++で開発 ] Doxygenコメント規約例 Doxygenは、非常に豊富なコメント書式を持っていますが、これらをすべて把握して適切なコメントを書くことは苦痛です。そこで、あらかじめ特定のコメント規約セットとそのDoxygen設定ファイルを定義し、これを雛形として使うのがよいかと思います。 コメント規約セット（その１） Java風味 JavaDocで慣れた人向けのC++用Doxygenコメント規約例を定義します。 Doxygen設定項目 設定項目 設定値 備考
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
詳細設計書なんて、書きたくない・・・・Doxygenを使って自動生成してみる - Qiita
コード構造を視覚化せよ！！（Graphviz & Doxygen）
Doxygen+Graphvizでクラス図を自動生成する - 毛のはえたようなもの
Doxygen を github-pages にあげるのをお気楽にやる方法 - tokuhirom's blog
Doxygen 向け C/C++ ファイルのコメントテンプレート - l1o0の日記
doxygen+graphvizでC++のソースコードを可視化する - nokunoの日記
ソースコードを読むのに Doxygen + Graphviz が便利な件
Doxygenで呼び出し関係図を含むドキュメントを生成する - M12i.
ソースコードからドキュメントをDoxygenで生成する
ecloxとdoxygenで仕様書メンテナンスの効率をUP！
doxygen用コメントの書き方
コードリーディングのお供には Doxygen & Graphviz が良いかもしれない - きのこる庭
[観] doxygen + graphviz で日本語を使った絵をドキュメントに埋め込む
Doxygen+Graphvizで、Objective-Cのクラス図を作る - Qiita
Doxymacs = Doxygen + Emacs
doxygenで、各種形式のドキュメントを作ってしまおう - ふにゃるんv2
ソースブラウザとしてのDoxygen(どきしじぇん) - RC3の日記
Doxygenで関数コールツリーを出力する - .logbook