summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2018-11-11 13:57:38 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2018-11-11 14:07:44 (GMT)
commit70c7e8f3491e1fa30a2eaa89b960dd5b4d7a2185 (patch)
tree2f1d9530d716cc9328c7f6644b778d4fb33d0504 /doc/commands.doc
parent933a6e3d74f9109ad6ec921aded645d87111585b (diff)
parent4682b91364247aafe66b6af472e321511e115e7c (diff)
downloadDoxygen-70c7e8f3491e1fa30a2eaa89b960dd5b4d7a2185.zip
Doxygen-70c7e8f3491e1fa30a2eaa89b960dd5b4d7a2185.tar.gz
Doxygen-70c7e8f3491e1fa30a2eaa89b960dd5b4d7a2185.tar.bz2
Merge branch 'feature/bug_inline_image' of https://github.com/albert-github/doxygen into albert-github-feature/bug_inline_image
Diffstat (limited to 'doc/commands.doc')
-rw-r--r--doc/commands.doc6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index e747a57..f04b543 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -3130,7 +3130,7 @@ class Receiver
\ref cmddocbookonly "\\docbookonly".
<hr>
-\section cmdimage \\image <format> <file> ["caption"] [<sizeindication>=<size>]
+\section cmdimage \\image['{'[option]'}'] <format> <file> ["caption"] [<sizeindication>=<size>]
\addindex \\image
Inserts an image into the documentation. This command is format
@@ -3162,6 +3162,10 @@ class Receiver
The size specifier in \LaTeX (for example `10cm` or
`4in` or a symbolic width like `\\textwidth`).
+ 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).
+
Here is example of a comment block:
\verbatim