@arg・@li【リスト】
@image【画像】
@~【出力言語フィルタ】
@example【例 (ファイル)】

@arg・@li【リスト】

メモ

構文

@arg リスト項目
@li  リスト項目

/// @li 項目1
/// @li 項目2
/// @li 項目3

HTML出力例

  • 項目1
  • 項目2
  • 項目3

@image【画像】

メモ

構文

@image 出力フォーマット ファイル名 ["キャプション"] [サイズ識別子=サイズ]
@image 出力フォーマット "ファイル名" ["キャプション"] [サイズ識別子=サイズ]

出力フォーマット:html | latex | docbook | rtf
ファイル名:半角スペースが含まれる場合、下の構文
サイズ識別子:width・height
サイズ:100px 等

/// @image html "image.jpg" "イメージ" width=100px height=50px

HTML出力例

image.jpg
イメージ

@~【出力言語フィルタ】

メモ

構文

@~[言語id] 【言語idが有効な場合の出力】

言語id:japanese・english 等
(省略):全ての出力言語で有効

/// @~japanese 日本語メッセージ@n
/// @~english English
/// Message@n @~french Message français@n
/// @~ Message

【OUTPUT_LANGUAGE=Japanese の場合】

日本語メッセージ
Message

【OUTPUT_LANGUAGE=English の場合】

English Message
Message

【OUTPUT_LANGUAGE=French の場合】

Message français
Message

【OUTPUT_LANGUAGE=Spanish の場合】

Message

@example【例 (ファイル)】

メモ

構文

@example サンプルファイル名

/// クラスの説明
/// @example example.cpp
class ClassExample
{
};

【HTML出力例】

各種例:
example.cpp.