summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2018-08-09 17:49:58 (GMT)
committeralbert-github <albert.tests@gmail.com>2018-08-09 17:49:58 (GMT)
commit4682b91364247aafe66b6af472e321511e115e7c (patch)
treee267667bec90cebd6a38c757c7b2047f7d7e22ec /doc/commands.doc
parent69829b043fb36a56d194dc31522b694379636855 (diff)
downloadDoxygen-4682b91364247aafe66b6af472e321511e115e7c.zip
Doxygen-4682b91364247aafe66b6af472e321511e115e7c.tar.gz
Doxygen-4682b91364247aafe66b6af472e321511e115e7c.tar.bz2
Inline images
Create the possibility of inline images with the `\image` command by means of the option `inline`.
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 6c680ee..a9973ce 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -3052,7 +3052,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
@@ -3084,6 +3084,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