画像を埋め込む

\dotfile <ファイル> ["キャプション"]

<ファイル> から dot によって生成された画像を、ドキュメントに挿入します。

最初の引数は画像のファイル名を指定します。 doxygen は、そのファイルを、DOTFILE_DIRS タグで指定されたパス (またはファイル) の中から探します。
dot ファイルが見つかった場合、それは dot ツールへの入力ファイルとして扱われます。
出来上がった画像は正しい出力ディレクトリに出力されます。
dot ファイル名が空白文字を含む場合は、ファイル名をクォート () で囲まなければなりません。

2番目の引数はオプショナルですが、これを使用して画像の下に表示される キャプションを指定することができます。
この引数は、たとえ空白文字を含んでいなくてもクォートで囲んで記述する 必要があります。
クォートはキャプションが表示されるときに除去されます。

しかし、dotじゃない画像ファイルを埋め込みたい場合は???

\image <format> <file> ["caption"] [<sizeindication>=<size>]

ドキュメントに画像を挿入します。 このコマンドはフォーマットを特定します。
したがって、一つの画像を 2つ以上のフォーマットで挿入したい場合は、 各フォーマットごとにこのコマンドを繰り返さなければなりません。

最初の引数で、出力フォーマットを指定します。
現在のところ、以下の値がサポートされています: html および latex。

2番目の引数で、画像のファイル名を指定します。
doxygen は、IMAGE_PATH タグの後に指定したパス (またはファイル) の中から、ファイルを探し出します。
画像が見つかると、それは、現在の出力ディレクトリにコピーされます。
画像名が空白文字を含んでいる場合は、クォート () で囲む必要があります。
ファイル名のかわりに絶対 URL を指定することもできます。
しかし、その場合、 doxygen は、画像のコピーも存在チェックもしません。

3番目の引数はオプションです。これを使うと、 画像の下に表示されるキャプションを指定することができます。
この引数は、1行に記述し、かつ空白文字を全く含まない場合であっても、 クォートで囲まなければなりません。
クォートは、キャプションが表示される前に取り除かれます。

4番目の引数もオプションです。これを使うと、 画像の幅や高さを指定することができます。
これは、 出力 (すなわち、フォーマット=latex) に対してのみ、有用です。
サイズ指示 は、width または height のいずれかです。
サイズは、 において有効なサイズ指定である必要があります (たとえば、10cm や 6in や \textwidth のようなシンボリックな幅指定)。

下は、コメント・ブロックの例です:

  /*! 私のアプリケーションのスナップショット
   *  \image html application.jpg
   *  \image latex application.eps "私のアプリケーション" width=10cm
   */

他のやつが@ならば@imageと書かないと認識しない。
また、下は、設定ファイルの関連部分の例です:

Expert/Input/IMAGE_PATH = my_image_dir

\警告 HTML に対する画像フォーマットは、 ユーザが使用しているブラウザがサポートしているものに制限されます。 については、画像フォーマットは、 Encapsulated PostScript (eps) でなければなりません。

doxygen は、画像が正しいフォーマットであるかどうかチェックしません。 したがって、それが正しいということは、ユーザが確認しなければなりません!

マークダウン記法で画像を表示

![Caption text](/path/to/img.jpg)
![Caption text](/path/to/img.jpg "Image title")
![Caption text][img def]
![img def]
 
[img def]: /path/to/img.jpg "Optional Title"
Also here you can use @ref to link to an image:
 
![Caption text](@ref image.png)
![img def]
 
[img def]: @ref image.png "Caption text"
サポートサイト Wikidot.com