Doxygen - 特殊コマンド
特殊コマンド はじめに ドキュメント内のすべてのコマンドは、バックスラッシュ (\)、 またはアットマーク (@) で始まります。 お望みであれば、以下のバックスラッシュで始まるすべてのコマンドを、 それに対応したアットマークで始まるものに置き換えることができます。 いくつかのコマンドは、1つまたはそれ以上の引数を取ります。 各引数には、ある決まった範囲があります: <山> 括弧が使われている場合、引数は 1単語からなります。 (丸) 括弧が使われている場合、引数は、コマンドのある場所からその行の終わりまでとなります。 {波} 括弧が使われている場合、引数は、次のパラグラフの頭までとなります。 パラグラフは、空行かセクション指示子で区切られます。 [角] 括弧が使われている場合、引数は省略可能です。 以下は、全コマンドをアルファベット順に整列したリストです (説明への参照付き)。
コードをドキュメント付けする
doxygen では、1つの簡易記述と1つの詳細記述だけが許されます。 もし、宣言の前に1つの簡易記述があり、 さらに定義の前にも1つの簡易記述があるとすると、 宣言の前にあるものだけが使用されます。 同様の状況が詳細記述にも生じた場合は、定義の前にあるものが優先され、 宣言の前にあるものは無視されます。 これは、Qt スタイルでドキュメントを記述した、C++ コードの例です: //! A test class. /*! A more elaborate class description. */ class Test { public: //! An enum. /*! More detailed enum description. */ enum TEnum { TVal1, /*!< Enum value TVal1. */ TVal2, /*!< Enum value TVa
http://www.fides.dti.ne.jp/~oka-t/doxygen-manual/html/commands.html
専用コマンド ドキュメント内のすべてのコマンドは、バックスラッシュ (\)、 または、アットマーク (@) で始まります。 お好みであれば、以下のバックスラッシュで始まるすべてのコマンドを、 それに対応したアットマークで始まるものに置き換えることができます。 いくつかのコマンドは、1つまたはそれ以上の引数を取ります。 各引数には、ある決まった範囲があります: <三角> カッコが使われている場合、引数は 1単語からなります。 (丸) カッコが使われている場合、引数は、 コマンドのある場所からその行の終わりまでとなります。 {波} カッコが使われている場合、引数は、次のパラグラフの頭までとなります。 パラグラフは、空行かセクション指示子で区切られます。 [四角] カッコが使われている場合、引数はオプションとなります。 以下は、全コマンドをアルファベット順にソートしたリストです (説明への参
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
