diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 36 |
1 files changed, 32 insertions, 4 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 8884b36..69f22e7 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -65,6 +65,7 @@ documentation: \refitem cmddontinclude \\dontinclude \refitem cmddot \\dot \refitem cmddotfile \\dotfile +\refitem cmdmscfile \\mscfile \refitem cmde \\e \refitem cmdelse \\else \refitem cmdelseif \\elseif @@ -320,7 +321,8 @@ Structural indicators \addindex \\dir Indicates that a comment block contains documentation for a directory. The "path fragment" argument should include the directory name and - enough of the path to be unique w.r.t. the other directories in the project. + enough of the path to be unique with respect to the other directories + in the project. The \ref cfg_show_dirs "SHOW_DIRECTORIES" option determines whether or not the directory information is shown and the \ref cfg_strip_from_path "STRIP_FROM_PATH" option determines what is @@ -1288,6 +1290,14 @@ void memcpy(void *dest, const void *src, size_t n); sectioning command is encountered. See section \ref cmdfn "\\fn" for an example. + Note that for PHP one can also specify the type (or types if you + separate them with a pipe symbol) which are allowed for a parameter + (as this is not part of the definition). + The syntax is the same as for phpDocumentor, i.e. +\verbatim +@param datatype1|datatype2 $paramname description +\endverbatim + <hr> \section cmdtparam \\tparam <template-parameter-name> { description } @@ -2046,7 +2056,7 @@ class C {}; Here is an example of the use of the \\msc command. \code /** Sender class. Can be used to send a command to the server. - * The receiver will acknowlegde the command by calling Ack(). + * The receiver will acknowledge the command by calling Ack(). * \msc * Sender,Receiver; * Sender->Receiver [label="Command()", URL="\ref Receiver::Command()"]; @@ -2096,6 +2106,24 @@ class Receiver stripped before the caption is displayed. <hr> +\section cmdmscfile \\mscfile <file> ["caption"] + + \addindex \\mscfile + Inserts an image generated by mscgen from \<file\> into the documentation. + + The first 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_mscfile_dirs "MSCFILE_DIRS" tag. + If the msc file is found it will be used as an input file to the mscgen tool. + The resulting image will be put into the correct output directory. + If the dot file name contains spaces you'll have to put quotes ("...") around it. + + The second 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. + +<hr> \section cmde \\e <word> \addindex \\e @@ -2265,7 +2293,7 @@ class Receiver 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. You can also specify an absolute URL instead of a file name, but then - doxygen does not copy the image nor check its existance. + doxygen does not copy the image nor check its existence. 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 @@ -2506,7 +2534,7 @@ class Receiver \addindex \\\" This command writes the \" character to the output. This character has to be escaped in some cases, because it is used in pairs - to indicate an unformated text fragment. + to indicate an unformatted text fragment. <hr> \htmlonly <center> \endhtmlonly |