Programing/Tool/Doxygen
Last-modified: Wed, 29 Dec 2021 14:56:50 JST (1116d)
概要
コマンド早見表
| 種類 | コマンド | 引数 | 省略 | 説明 |
| ブロック | class | <class> | o | クラスの説明ブロックを示す。 |
| def | <macro> | o | マクロの説明ブロックを示す。 | |
| enum | ||||
| example | ||||
| file | ||||
| fn | <function> | o | 関数の説明ブロックを示す。 | |
| headerfile | ||||
| interface | ||||
| internal | ||||
| mainpage | ||||
| namespace | o | 名前空間の説明ブロックを示す。 | ||
| page | ||||
| relates | ||||
| struct | ||||
| typedef | ||||
| union | ||||
| var | ||||
| セクション | attention | |||
| author | ||||
| brief | 概要を記載する | |||
| bug | ||||
| date | ||||
| deprecated | ||||
| details | 詳細な説明を記載する | |||
| exception | ||||
| note | ||||
| param | ||||
| post | ||||
| pre | ||||
| return | ||||
| retval | ||||
| sa | ||||
| test | ||||
| todo | ||||
| version | ||||
| warning | ||||
| リンク | anchor | |||
| ref | ||||
| 実例 | include | |||
| 強調 | a | <arg> | x | 文中の<arg>を引数として強調表示する |
| b | <word> | x | 文中の<word>を太字で表示する | |
| c | <word> | x | 文中の<word>をタイプライタフォントで表示する | |
| code-endcode | x | ブロックをc/c++のコードとして表示する | ||
| copydoc | <link-object> | x | <link-object>で指定したオブジェクトの説明をコピーする。継承元の説明などを再利用する際に使用 | |
| dot-enddot | x | ブロックをdotグラフとして表示する | ||
| msc-endmsc | x | ブロックをmscメッセージシーケンスとして表示する | ||
| dotfile | <file>["caption"] | x | <file>からdotによって生成した画像を"caption"をタイトルとして表示する | |
| e | <word> | x | <word>をイタリック体で表示する | |
| f[-f] | x | ブロックをLATEX形式の数式として表示する | ||
| image | <fortmat><file>["caption"] | x | ドキュメントに<format>出力フォーマットで"caption"をタイトルとして<file>を画像として表示する | |
| li | <sentence> | x | 空行または別のliまでの<sentence>文をリスト表示する。 | |
| n | x | 強制的に改行する |
