diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 67 |
1 files changed, 44 insertions, 23 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index d391c2c..34853af 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -176,6 +176,17 @@ Doxygen. Unrecognized commands are treated as normal text. group of classes, files or namespaces. This can be used to categorize classes, files or namespaces, and document those categories. + + The \<name\> argument should an single word identifier. + + \par Example: + \verbinclude group.cpp + + \htmlonly + Click <a href="$(DOXYGEN_DOCDIR)/examples/group/html/modules.html">here</a> + for the corresponding HTML documentation that is generated by Doxygen. + \endhtmlonly + \sa section \ref cmdingroup "\\ingroup" <hr> @@ -197,7 +208,7 @@ Doxygen. Unrecognized commands are treated as normal text. If a comment block is located directly in front of an enum declaration, the \\enum comment may be omitted. - \par Notice: + \par Note: The type of an anonymous enum cannot be documented, but the values of an anonymous enum can. @@ -274,11 +285,12 @@ Doxygen. Unrecognized commands are treated as normal text. \sa section \ref cmdvar "\\var" and \ref cmdtypedef "\\typedef". <hr> -\subsection cmdingroup \ingroup <groupname> +\subsection cmdingroup \ingroup (<groupname> [<groupname> <groupname>]) \addindex \ingroup If the \\ingroup command is placed in a comment block of a - class, file or namespace, then it will be added to the group. + class, file or namespace, then it will be added to the group or + groups identified by \<groupname\>. \sa section \ref cmddefgroup "\\defgroup". @@ -345,10 +357,10 @@ Doxygen. Unrecognized commands are treated as normal text. Any other documentation that is inside the documentation block will by appended after the generated message. - \par Notice 1: + \par Note 1: You are responsible that there is indeed an earlier documented member that is overloaded by this one. - \par Notice 2: + \par Note 2: The \\overload command does not work inside a one-line comment. \par Example: \verbinclude examples/overload.cpp @@ -374,7 +386,7 @@ Doxygen. Unrecognized commands are treated as normal text. for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \par notice: + \par Note: The \<name\> argument consists of a combination of letters and number digits. If you wish to use upper case letters (e.g. \c MYPAGE1), or mixed case letters (e.g. \c MyPage1) in the \<name\> argument, you @@ -693,7 +705,7 @@ Doxygen. Unrecognized commands are treated as normal text. See section \ref autolink "\\autolink" for more information on automatically generated links and valid link-objects. - \b Notice: + \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. @@ -843,7 +855,7 @@ Doxygen. Unrecognized commands are treated as normal text. the example, is set to the start of the line following the line that is written (or to the end of the example if the pattern could not be found). - \par Notice: + \par Note: The command: \verbatim\skipline pattern\endverbatim is equivalent to: @@ -921,7 +933,7 @@ Doxygen. Unrecognized commands are treated as normal text. </ul><br> No other types of alignment are supported. - \par Notice: + \par Note: For nested lists, HTML commands should be used. <hr> @@ -1021,11 +1033,11 @@ Doxygen. Unrecognized commands are treated as normal text. endhtmlonly command. This command can be used to include HTML code that is too complex - for Doxygen (i.e. images, applets, java-scripts, and HTML tags that + for Doxygen (i.e. applets, java-scripts, and HTML tags that require attributes). You can use the \\latexonly and \\endlatexonly pair to provide a proper \f$\mbox{\LaTeX}\f$ alternative. - \b Notice: + \b Note: environment variables (like \$(HOME) ) are resolved inside a HTML-only block. @@ -1043,12 +1055,13 @@ Doxygen. Unrecognized commands are treated as normal text. The first argument specifies the output format. Currently, the following values are supported: \c html and \c latex. - The second argument specifies the path and file name of the image. - If a relative path is used, this will be relative to the directory to - which the output of the particular format is written. - For the html format you may also - specify an URL. If the name contains spaces you'll have to put - quotes (") around it. + 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 and filter those files through the patterns + you specified after the \ref cfg_image_patterns "IMAGE_PATTERNS" 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 @@ -1057,19 +1070,28 @@ Doxygen. Unrecognized commands are treated as normal text. size specifier in \f$\mbox{\LaTeX}\f$ (for example <code>10cm</code> or <code>6in</code>). + Here is example of a comment block: + \verbatim /*! Here is a snapshot of my new application: - * \image html ../images/application.jpg - * \image latex ../images/application.eps width=10cm + * \image html application.jpg + * \image latex application.eps width=10cm */ \endverbatim + And this is an example of how the configuration file may look: + +\verbatim + IMAGE_PATH = my_image_dir + IMAGE_PATTERNS = *.eps *.gif *.jpg +\endverbatim + \warning The image format for HTML is limited to what your browser supports. For \f$\mbox{\LaTeX}\f$ the image format must be an encapsulated postscipt (eps). <br><br> - Doxygen does not check if an image exists or if it is in - the correct format. So \e you have to make sure this is the case! + Doxygen does not check if the image is in the correct format. + So \e you have to make sure this is the case! <hr> \subsection cmdlatexonly \latexonly @@ -1084,7 +1106,7 @@ Doxygen. Unrecognized commands are treated as normal text. use the \\htmlonly and \\endhtmlonly pair to provide a proper HTML alternative. - \b Notice: + \b Note: environment variables (like \$(HOME) ) are resolved inside a \f$\mbox{\LaTeX}\f$-only block. @@ -1209,7 +1231,6 @@ browser generator. Do \e not use these commands in your own documentation. <li>\\functionindex <li>\\header <li>\\headerfilelist -<li>\\ingroup <li>\\inherit <li>\\l <li>\\postheader |