Programing/Tool/Doxygen

Last-modified: Wed, 29 Dec 2021 14:56:50 JST (901d)
Top > Programing > Tool > Doxygen

概要

コマンド早見表

種類コマンド引数省略説明
ブロックclass<class>oクラスの説明ブロックを示す。
def<macro>oマクロの説明ブロックを示す。
enum
example
file
fn<function>o関数の説明ブロックを示す。
headerfile
interface
internal
mainpage
namespaceo名前空間の説明ブロックを示す。
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-endcodexブロックをc/c++のコードとして表示する
copydoc<link-object>x<link-object>で指定したオブジェクトの説明をコピーする。継承元の説明などを再利用する際に使用
dot-enddotxブロックをdotグラフとして表示する
msc-endmscxブロックを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>文をリスト表示する。
nx強制的に改行する

リンク