diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 35 |
1 files changed, 20 insertions, 15 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 37d4890..dd0c378 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -909,7 +909,7 @@ Public/Protected/Private/... section. \sa section \ref cmdlink "\\link". <hr> -\subsection cmdlink \link <link-object> +\subsection cmdlink \link <link-object> \addindex \link The links that are automatically generated by Doxygen always have the @@ -924,10 +924,6 @@ Public/Protected/Private/... section. See section \ref autolink "autolink" for more information on automatically generated links and valid link-objects. - \b Note: - Keep in mind that links are only meaningful in HTML text; - in \f$\mbox{\LaTeX}\f$ text, the link text is just written to the output. - <hr> \subsection cmdref \ref <name> ["(text)"] @@ -1315,7 +1311,7 @@ Public/Protected/Private/... section. \ref cmdlatexonly "\\latexonly". <hr> -\subsection cmdimage \image <format> <file> [<sizeindication>=<size>] +\subsection cmdimage \image <format> <file> ["<caption>"] [<sizeindication>=<size>] \addindex \image Inserts an image into the documentation. This command is format @@ -1327,27 +1323,36 @@ Public/Protected/Private/... section. The second argument specifies the file name of the image. Doxygen will look for files in the paths (or files) that you specified - after the \ref cfg_image_path "IMAGE_PATH" tag. + after the \ref cfg_image_path "IMAGE_PATH" tag. If the image is found it will be copied to the correct output directory. If the image name contains spaces you'll have to put quotes (") around it. - - The third argument can be used to specify the width or height of the - image. This is only useful for \f$\mbox{\LaTeX}\f$ output - (i.e. format=latex). \c sizeindication can be either - \c width or \c height. The size should be a valid + You can also specify an absolute URL instead of a file name, but then + doxygen does not copy the image or check its existance. + + The third argument is optional and can be used to specify the caption + that is displayed below the image. This argument has to be specified + between quotes even if it does not contain any spaces. The quotes are + stripped before the caption is displayed. + + The fourth argument is also optional and can be used to specify the + width or height of the image. This is only useful + for \f$\mbox{\LaTeX}\f$ output + (i.e. format=<code>latex</code>). The \c sizeindication can be + either \c width or \c height. The size should be a valid size specifier in \f$\mbox{\LaTeX}\f$ (for example <code>10cm</code> or - <code>6in</code>). + <code>6in</code> or a symbolic width like <code>\\textwidth</code>). Here is example of a comment block: \verbatim /*! Here is a snapshot of my new application: * \image html application.jpg - * \image latex application.eps width=10cm + * \image latex application.eps "My application" width=10cm */ \endverbatim - And this is an example of how the configuration file may look: + And this is an example of how the relevant part of the configuration file + may look: \verbatim IMAGE_PATH = my_image_dir |