summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <doxygen@gmail.com>2019-08-31 14:29:08 (GMT)
committerGitHub <noreply@github.com>2019-08-31 14:29:08 (GMT)
commit272cd04fd10401b2e196679ba81c64cd457164e4 (patch)
tree45156aa1df5d1c330cd4c66f0b7b37bc02c0adbd /doc
parent48f0fdecd82d7f390710ec19e07d14ff5b53f584 (diff)
parentbc773f438cf7230b64fdba422d28ef5ad0d95696 (diff)
downloadDoxygen-272cd04fd10401b2e196679ba81c64cd457164e4.zip
Doxygen-272cd04fd10401b2e196679ba81c64cd457164e4.tar.gz
Doxygen-272cd04fd10401b2e196679ba81c64cd457164e4.tar.bz2
Merge pull request #7239 from albert-github/feature/bug_docu_image
Correction documentation `\image` command
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 48991fb..59bf874 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -3191,7 +3191,7 @@ class Receiver
\anchor image_sizeindicator \par Size indication
The \c sizeindication can specify the width or height to be used (or a combination).
The size specifier in \LaTeX (for example `10cm` or
- `4in` or a symbolic width like `\\textwidth`).
+ `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
@@ -3214,8 +3214,10 @@ class Receiver
\endverbatim
\warning The image format for HTML is limited to what your
- browser supports. For \LaTeX, the image format
- must be Encapsulated PostScript (eps).
+ browser supports.<br>For \LaTeX, the image format
+ must be supported by the \LaTeX `\includegraphics` command i.e.
+ Encapsulated PostScript (eps), Portable network graphics (png),
+ Joint photographic experts group (jpg / jpeg).
<br><br>
Doxygen does not check if the image is in the correct format.
So \e you have to make sure this is the case!