タグ

doxygenに関するkiyo_hikoのブックマーク (16)

  • Doxygen

    設定 フォーマット 設定ファイルは、Makefile に似た構造を持つ、自由形式の ASCII テキストファイルで、デフォルトでは Doxyfile という名前になります。 ファイルは、doxygen によって解析されます。 書式設定のため、タブや改行コードを入れられます。 ステートメントは、大文字と小文字が区別されます。 ファイル内のどこにでもコメントを置くことができます (クォートの中を除く)。 コメントは、# 文字で始まり、行の終わりまで続きます。 ファイルは、質的には、代入文のリストからなっています。 各ステートメントは、大文字で書かれた TAG_NAME の後に = 文字と1つ以上の値が続いたものです。 同じタグへの代入が 2回以上現れた場合は、最後の代入文だけが有効になります。 引数にリストを指定するオプションについては、= のかわりに += 演算子を使って、リストに新しい値

    kiyo_hiko
    kiyo_hiko 2012/12/13
    「HTML_HEADER」タグで生成されるHTMLに含めるヘッダーを書けるので、ここにLINK書けばCSSを乗せられるらしい
  • Has anyone used Sphinx to document a C++ project?

  • DoxygenとPlantUMLを組み合わせて使う - rabbit2goのブログ

    以前にTracのプラグインと連携させて動かしたPlantUMLを、今回はDoxygenから使ってみた。下記のサイトに概要が載っているので分かると思うけど、目標は「ソースコードのコメントに書いた記述に従ってPlantUMLにUML図面を生成させ、これをDoxygenが出力するHTMLの中に含める」ことだ。 Integration with Doxygen documentation tool 動作環境は下記の通り。 MacOS X 10.6.4 (Snow Leopard) MacPorts 1.9.1 graphviz @2.26.3_2 (MacPorts) doxygen @1.7.1_0 (MacPorts) 手順は下記の通り。 環境変数にGRAPHVIZ_DOTを設定する。 $ export GRAPHVIZ_DOT=/opt/local/bin/dot ソースコードにコメントを記

    DoxygenとPlantUMLを組み合わせて使う - rabbit2goのブログ
  • http://onlineconsultant.jp/pukiwiki/?Doxygen%2FGraphviz%E3%81%A7%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88%E3%82%92%E8%87%AA%E5%8B%95%E7%94%9F%E6%88%90%E3%81%99%E3%82%8B

    http://onlineconsultant.jp/pukiwiki/?Doxygen%2FGraphviz%E3%81%A7%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88%E3%82%92%E8%87%AA%E5%8B%95%E7%94%9F%E6%88%90%E3%81%99%E3%82%8B
    kiyo_hiko
    kiyo_hiko 2012/06/12
    PHPでDoxygen
  • Doxygen - 特殊コマンド

    特殊コマンド はじめに ドキュメント内のすべてのコマンドは、バックスラッシュ (\)、 またはアットマーク (@) で始まります。 お望みであれば、以下のバックスラッシュで始まるすべてのコマンドを、 それに対応したアットマークで始まるものに置き換えることができます。 いくつかのコマンドは、1つまたはそれ以上の引数を取ります。 各引数には、ある決まった範囲があります: <山> 括弧が使われている場合、引数は 1単語からなります。 (丸) 括弧が使われている場合、引数は、コマンドのある場所からその行の終わりまでとなります。 {波} 括弧が使われている場合、引数は、次のパラグラフの頭までとなります。 パラグラフは、空行かセクション指示子で区切られます。 [角] 括弧が使われている場合、引数は省略可能です。 以下は、全コマンドをアルファベット順に整列したリストです (説明への参照付き)。

    kiyo_hiko
    kiyo_hiko 2012/02/29
    Javadocとはまた若干違う感じ literalとかlinkplainとかはなさげ
  • 電八開発倶楽部 - Doxygenコメント

    コメントの義務 他のコメント同様doxygenコメントも義務ではありません。コメントを付けようと思うとき、doxygenコメントにすることも義務ではありません。普通のコメントが付いていれば誰かがdoxygen形式に直します。たぶん。 ただし、コメントを付けるときにDoxygenコメントに配慮することは義務です。doxygenコメントは以下のコメント書式で始まりますので、ドキュメントに出力される必要の無いコメントはこのコメント書式を避けてください。 /** /*! //! /// Doxygenコメントの書き方 以下では、doxygenコメントの電八ソースにおけるルールを示します。つまり、doxygen自体の使い方は主眼ではないです。より良いルールに改訂するためにご意見をお待ちしています。 doxygenは割とメジャーなツールなので、使い方自体はウェブ上に大量の参考になるページがあります。使

    kiyo_hiko
    kiyo_hiko 2012/02/29
    Doxygen運用の参考例
  • 静的解析フリーツール/固有値解析フリーソフト最新ダウンロード情報

    Java静的解析・C言語/C#/C++静的解析・ソースコードの静的解析などに用いるフリーツールや、固有値の解析や計算に役立つフリーソフトの最新情報を集めました。 有用なシェアウェアの無料試用版に関する情報も併せて掲載しています。 ■Dehydra■(https://developer.mozilla.org/en/Dehydra) この静的解析ツールの特長: 「Dehydra」は、無料ダウンロードできるC++静的解析ツールで、GCCの型情報などをユーザーのJavaScriptコードに引き渡す役割を果たします。オブジェクトコードは再びGCCに戻すことは不可能で、最適化はできないものの、C++静的解析を行う機能としては十分でしょう。制御構造なども調べる必要がある場合は、「Treehydra」(https://developer.mozilla.org/en/Treehydra)が有効です。Li

  • Doxygen 向け C/C++ ファイルのコメントテンプレート - l1o0の日記

    Doxygen 高機能なんだけど、高機能すぎてどうやって Doxygen 用のコメントを書けばいいのかよくわからん。コメントとルール作りも兼ねてテンプレートを作っておこう。 Doxygen のいいところはソースコードが可視化されることもあるけど、コメントを付けてないとソースコード解析時に「コメントが付いとらん」と警告してくれるところ。さぼってコメントを付けないのを防いでくれる。 Doxygen C/C++ テンプレート comment.c /**********************/ /* ファイルヘッダの例 */ /**********************/ /******************************************************************************/ /*! @addtogroup モジュール名_サブモジュール名

    Doxygen 向け C/C++ ファイルのコメントテンプレート - l1o0の日記
  • PerlDoxygen

    kiyo_hiko
    kiyo_hiko 2011/12/08
    Perl Doxygen Filterが新しい開発者に引き継がれてた。そのうち新版の動作確認してみよう。ちなみに旧版だとインデントしてるとJavadoc風味のAPIコメントが無視されてしまって、結構嵌った。
  • ecloxとdoxygenで仕様書メンテナンスの効率をUP!

    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」を使ったドキュメントの自動生成について解説します。 今回の内容を読み進める前に、これまでの連載記事をもう一度読んでおくと、よ

    ecloxとdoxygenで仕様書メンテナンスの効率をUP!
    kiyo_hiko
    kiyo_hiko 2011/11/28
    Javadocとほとんど一緒の記法で書ける。よさげ
  • uhaku @Wiki - doxygen+graphviz

    Doxygen は、C、JavaPythonPHP向けのドキュメンテーションツールです。 ドキュメンテーションされたプログラムソースファイルからAPIリファレンスマニュアルなどを作成することが出来ます。

    uhaku @Wiki - doxygen+graphviz
    kiyo_hiko
    kiyo_hiko 2011/04/07
    詳しい+わかりやすい。
  • Graphviz ダウンロード - Doxygen @ ウィキ

    3. 利用規約をよく読み、よく理解してからページ最下部にある、[ Agree ]と[ Disagree ]の2つの内、[ Agree ]を選択して次のページに行きます。 ( ちなみに、一度[ Agree ]を選択すると、Cookieを削除しない限り次回以降そのページに行かずにその先のページまで行くようになります。 )

    Graphviz ダウンロード - Doxygen @ ウィキ
  • graphviz

    Graphviz 使いかた http://www.graphviz.org/ グラフ自動生成ツール 日語のマニュアルが見付からなかったので自分が使うところだけをまとめてみ る。 もちろん超意訳なので間違いが多々あると思いますので御了承下さい。(という かそんなにまじめに訳していない) 各種ツールの位置付け dot: 有向グラフ作成用 neato: 無向グラフ作成用 twopi: 放射状グラフ(radial layouts of graphs) circo: 循環グラフ(circular layout of graphs) fdp: 無向グラフ作成用 dotファイルは同じだけれど、これら各種グラフごとにレイアウトが異なる。 マニュアル コマンドライン解説 % dot [-(G|N|E)name=value] [-Tlang] [-l libfile] [-o outfile] [-v] [

  • 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は下記のサイトから入

  • コード構造を視覚化せよ!!(Graphviz & Doxygen)

    日頃より楽天のサービスをご利用いただきましてありがとうございます。 サービスをご利用いただいておりますところ大変申し訳ございませんが、現在、緊急メンテナンスを行わせていただいております。 お客様には、緊急のメンテナンスにより、ご迷惑をおかけしており、誠に申し訳ございません。 メンテナンスが終了次第、サービスを復旧いたしますので、 今しばらくお待ちいただけますよう、お願い申し上げます。

  • JavaやC++(オブジェクト思考)のソースから、設計を理解するために、 必要なポイントを教えてください。…

    JavaC++(オブジェクト思考)のソースから、設計を理解するために、 必要なポイントを教えてください。フレームワークの解析に必要な観点とか を教えてください。

    kiyo_hiko
    kiyo_hiko 2011/04/06
    自分のプロジェクトも設計文書もAPI仕様書(javadoc)もないのだが、試しにdoxygenを使ってみよう→doxygenはコメントが書かれてないと実力が発揮できない・・・ツールとしては期待度高し
  • 1