使用 Doxygen 内联显示图像 [英] Display image inline using Doxygen

问题描述

我正在使用 Doxygen 从 Markdown 文件生成 html 用户手册.我想给出诸如单击 [image.png] 按钮"之类的说明，并使 png 图像出现在生成的 html 的文本行中.

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.

根据 Doxygen 的文档，可以添加图片如下:\image['{'[option]'}'] <格式><文件>["caption"] [=]

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

文档还说目前仅支持选项 inline.如果指定选项 inline，图像将放置在行中"，当出现标题时，它会在 HTML 中显示为工具提示(其他格式忽略)."这听起来像我想要做的.

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.

我尝试了 \image 命令的几种变体，但都没有成功.这些成功地生成了一个图像，但在它自己的行上:

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"

并且这些命令失败:

\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?

推荐答案

{inline} 选项和 \image 命令在 1.8.15 版本中引入版本:

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

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

在 1.8.15 中有效.

does work in 1.8.15.

OP 使用旧版本，会收到如下警告:

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

警告:图像类型内联指定为内联的第一个参数警告无效:{ command

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

这篇关于使用 Doxygen 内联显示图像的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！