Display image inline using Doxygen

1
votes

I'm using Doxygen to generate an html user manual from markdown files. I'd like to give instructions such as "Click on the [image.png] button" and have the png image appear in the line of text in the generated html.

According to Doxygen's documentation, images can be added as follows: \image['{'[option]'}'] <format> <file> ["caption"] [<sizeindication>=<size>]

The documentation also says that "Currently only the option inline is supported. In case the option inline is specified the image is placed "in the line", when a caption s present it is shown in HTML as tooltip (ignored for the other formats)." This sounds like what I want to do.

I've tried several variations of the \image command with no luck. These successfully produce an image, but on its own line:

!["caption"](image.png)
\image html image.png "caption"

and these commands fail:

\image inline html image.png "caption"
\image{inline} html image.png "caption"

Does anyone know if it's possible to do what I'm trying to achieve? Am I just getting the syntax wrong?

2
htmlimagemarkdowndocumentationdoxygen
Which version are you using (I assume 1.8.15), but please double check with doxygen -v. The version with \image{inline} html image.png "caption" should work. - albert
@albert - I'm using version 1.8.14. - Nathan Pickle

2 Answers

2
votes

The {inline} option with the \image command is introduced in version 1.8.15 The version:

\image{inline} html image.png "caption"

does work in 1.8.15.

OP used an older version and will have got warnings like:

warning: image type inline specified as the first argument of inline is not valid warning: expected whitespace after { command

0
votes

I was having this problem too. This line fixed it for me:

 \image html name.png width=800cm height=600cm