おっちょこちょい doxygen備忘録-日本語・英語の出力切り替え
doxygenで作成したプログラムのマニュアルの日本語・英語表記の切り替え方． 切り替え自体はdoxygenの設定ファイルで"OUTPUT_LANGUAGE"を"Japanese"または"English"にすればよい． もちろん，ソースコードに記述されたマニュアルの内容は日本語・英語の両方に対して作成しなければならない． それは，次のようにするとよい． /*! @file * @~english * @brief Implementation of functions * @~japanese * @brief 関数の実装 * @~ * @author ottyokotyoi */ このように，"@~"タグを利用して，言語切り替え時のコンテンツを切り替えれる． 最後の言語指定のない"@~"タグは，すべての言語を意味する．
Doxygen - 特殊コマンド
特殊コマンド はじめに ドキュメント内のすべてのコマンドは、バックスラッシュ (\)、 またはアットマーク (@) で始まります。 お望みであれば、以下のバックスラッシュで始まるすべてのコマンドを、 それに対応したアットマークで始まるものに置き換えることができます。 いくつかのコマンドは、1つまたはそれ以上の引数を取ります。 各引数には、ある決まった範囲があります: <山> 括弧が使われている場合、引数は 1単語からなります。 (丸) 括弧が使われている場合、引数は、コマンドのある場所からその行の終わりまでとなります。 {波} 括弧が使われている場合、引数は、次のパラグラフの頭までとなります。 パラグラフは、空行かセクション指示子で区切られます。 [角] 括弧が使われている場合、引数は省略可能です。 以下は、全コマンドをアルファベット順に整列したリストです (説明への参照付き)。
コード構造を視覚化せよ！！（Graphviz & Doxygen）
日頃より楽天のサービスをご利用いただきましてありがとうございます。 サービスをご利用いただいておりますところ大変申し訳ございませんが、現在、緊急メンテナンスを行わせていただいております。 お客様には、緊急のメンテナンスにより、ご迷惑をおかけしており、誠に申し訳ございません。 メンテナンスが終了次第、サービスを復旧いたしますので、 今しばらくお待ちいただけますよう、お願い申し上げます。
doxygen 設定
フォーマット 設定ファイルは、Makefile に似た構造を持つ、 自由形式の ASCII テキストファイルで、デフォルトでは Doxyfile という名前になります。 ファイルは、doxygen によって解析されます。 見た目を整えるために、タブや改行コードを含むこともできます。 「文」は、大文字・小文字が区別されます。 ファイル内のどこにでもコメントを置くことができます (クォートの中を除く)。 コメントは、# 文字で始まり、行の終わりまで続きます。 ファイルは、本質的には、代入文のリストからなっています。 各々の文は、大文字で書かれた TAG_NAME の後に = 文字と1つ以上の値が続いたものです。 同じタグへの代入が 2回以上現れた場合は、最後の代入文だけが有効になります。 引数としてリストをとるオプションに対しては、= のかわりに += 演算子を使って、リストに新しい値を追加す
Doxygen使い方覚書 - WeBLoG
何処かで書いたよなぁと思って日記を検索したら 出てこなかったので・・・ 僕の使い方はHtmlをサーバーに置いていつでもアクセス・・・ というよりはコンパイル済みヘルプファイルにして エディタから一発検索する為に使っている Namazu等を入れても貧弱なサーバーでは時間が掛かってしまうので・・・ (※1.41で確認していますので最新のバージョンでは少し動作が違うかもしれません) 設定ファイルとコメントの書き方載せたら やたら長くなったので省略します・・・ まず必要なツール Doxygen本体 Doxygen クラスの相関図を出すためのグラフツール Graphviz コンパイル済みHTMLを吐くのにこのツールの中の「hhc.exe」が必要 MSDN Online Library：Microsoft HTML Help Downloads Doxygen用のコメントの書き方 C++用ですが・・・
doxygen用コメントの書き方
コメントの書き方(クラス・関数のコメント) このページの最新版は以下の場所をご覧くださいhttp://sakura-editor.wiki.sourceforge.net/DoxygenComment ソースコード中のコメントをdoxygenの 解説に反映させるためのコメントの書き方です。新規にコメントを入れる場合は以下のルールにできるだけ従うようにしてください。 関数内のコメントはこのルールに従っていただいても意味がありません ので通常のコメントで結構です。ドキュメント生成に関係するのは、 ファイル クラス メンバー関数（Inline含む） メンバー変数 グローバル変数 クラスのメンバーでない関数 定数宣言 (#define, enum) です。 doxygenで認識されるコメント スタイル doxygenではQtスタイル及びJavaDocスタイルのコメン トを認識します．コメントには要
Doxygenを使ってみる(2)
Doxygenでドキュメントを作成 Doxygenの実行について インストーラでインストールした場合、GUIのウイザードもインストールされます。 ウイザードを使用すれば設定ファイルの生成からドキュメントの生成まで行うことができますが、 ここでは、コマンドラインを使用してドキュメントを作成します。 ウイザードでも基本的操作は変わりません。 設定ファイルを作成・保存し、doxygenを実行するのをGUI上で行うようになっています。 ソースにコメントをつける doxygen ではQtタイプとJavadocタイプのコメントがサポートされています。 Qtタイプ例 /*! コメント */ Javadocタイプ例 /** * コメント */ ここではJavadocタイプのコメントからドキュメントを生成します。 サンプルとして以下のような2つのクラスのヘッダファイルにJavadoc風にコメントを記載します
OKA のページ
お題は 『ソフトウェア職人気質』 から拝借。 この本、40代・50代になってもプログラマを続けていきたい人には必読です。 私も 「熟達職人」を目指して修業中。 (そこっ、手遅れって言うなー!) 更新・近況・一言 技術ノートに、 CVS: UNIX クライアントで sjis ⇔ euc 変換 を追加。CVS ネタですが、要するに、 Windows とか Mac とかでちまちまとコード変換するのではなくて、 UNIX側でまとめて対応してしまいましょう、という話。 C++ ラビリンス C++ の迷宮をさまよう同志たちへ贈る、ささやかな道標。 自己言及的なテンプレート (その2) (2003-03-09) boost::spirit を使う (2003-05-11) VC6 の関数テンプレートのバグにハマる (2003-05-25) doxygen C++ (および C、Java、IDL) のソー
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
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
