タグ

ブックマーク / www.doxygen.jp (3)

  • Doxygen マニュアル

    Doxygen マニュアル このマニュアルは 3つのパートに分かれています。 それぞれのパートは、さらにいくつかのセクションに分かれます。 パート 1 は、ユーザー・マニュアルです。 セクション インストール では、 ダウンロード、コンパイル、 インストールの方法を説明します。 セクション はじめよう では、最初のドキュメントを素早く生成する方法を説明します。 セクション コードのドキュメント付け では、コードにドキュメントを付けるための様々な方法を例示します。 セクション リスト では、リストを作成する様々な方法を示します。 セクション グループ化 では、グループ化の方法を示します。 セクション 式のインクルード では、ドキュメントに式を挿入する方法を示します。 セクション グラフと図 では、Doxygen で生成できる図とグラフを説明します。 セクション プリプロセス では、Doxyg

  • Doxygen - 特殊コマンド

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

    takashi001
    takashi001 2022/06/06
    doxygen
  • Doxygen:コードのドキュメント付け

    コードのドキュメント付け 特殊ドキュメント・ブロック 特殊ドキュメント・ブロックは、C または C++スタイルのコメントブロックにマークを付け加えたもので、Doxygenはこれをドキュメント断片と認識して、ドキュメントを生成します。 PythonとVHDLコードについては、別のコメント表記規則があります。セクションPython での特殊ドキュメント・ブロック と VHDL での特殊ドキュメント・ブロック で説明します。 各コード要素について、説明形式が2(3の場合も)種類あり、これらがドキュメントを形成します。それは、要約説明と 詳細説明で、どちらもオプションです。メソッドと関数については、もうひとつの形式があり、いわゆる"文内"説明で、メソッドや関数の体内のコメントブロックの連結からなります。 ひとつ以上の要約説明または詳細説明を指定できます。(ただし、出現順序が指定されていないため

    takashi001
    takashi001 2016/05/30
    書き方
  • 1