doxygen_manual-1.8.1 (1035109), страница 37
Текст из файла (страница 37)
doxygen will look for files in the paths (or files) that youspecified after the DOTFILE_DIRS tag. If the dot file is found it will be used as an input file to the dot tool. TheGenerated by Doxygen148Special Commandsresulting image will be put into the correct output directory. If the dot file name contains spaces you’ll have to putquotes ("...") around it.The second argument is optional and can be used to specify the caption that is displayed below the image.
Thisargument has to be specified between quotes even if it does not contain any spaces. The quotes are stripped beforethe caption is displayed.21.122 \mscfile <file> [”caption”]Inserts an image generated by mscgen from <file> into the documentation. See http://www.mcternan.-me.uk/mscgen/ for examples.The first argument specifies the file name of the image.
doxygen will look for files in the paths (or files) that youspecified after the 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 msc file name contains spaces you’ll have toput quotes ("...") around it.The second argument is optional and can be used to specify the caption that is displayed below the image. Thisargument has to be specified between quotes even if it does not contain any spaces. The quotes are stripped beforethe caption is displayed.See alsosection \msc.21.123 \e <word>Displays the argument <word> in italics. Use this command to emphasize words.Example:Typing:...
this is a \e really good example ...will result in the following text:... this is a really good example ...Equivalent to \a and \em. To emphasize multiple words use <em>multiple words</em>.21.124 \em <word>Displays the argument <word> in italics. Use this command to emphasize words.Example:Typing:...
this is a \em really good example ...will result in the following text:... this is a really good example ...Equivalent to \a and \e. To emphasize multiple words use <em>multiple words</em>.Generated by Doxygen21.125 \endcode21.125 \endcodeEnds a block of code.See alsosection \code21.126 \enddotEnds a blocks that was started with \dot.21.127 \endmscEnds a blocks that was started with \msc.21.128 \endhtmlonlyEnds a block of text that was started with a \htmlonly command.See alsosection \htmlonly.21.129 \endlatexonlyEnds a block of text that was started with a \latexonly command.See alsosection \latexonly.21.130 \endmanonlyEnds a block of text that was started with a \manonly command.See alsosection \manonly.21.131 \endrtfonlyEnds a block of text that was started with a \rtfonly command.See alsosection \rtfonly.Generated by Doxygen149150Special Commands21.132 \endverbatimEnds a block of text that was started with a \verbatim command.See alsosection \verbatim.21.133 \endxmlonlyEnds a block of text that was started with a \xmlonly command.See alsosection \xmlonly.21.134 \f$Marks the start and end of an in-text formula.See alsosection formulas for an example.21.135 \f[Marks the start of a long formula that is displayed centered on a separate line.See alsosection \f] and section formulas.21.136 \f]Marks the end of a long formula that is displayed centered on a separate line.See alsosection \f[ and section formulas.21.137 \f{environment}{Marks the start of a formula that is in a specific environment.NoteThe second { is optional and is only to help editors (such as Vim) to do proper syntax highlighting by makingthe number of opening and closing braces the same.See alsosection \f} and section formulas.Generated by Doxygen21.138 \f}15121.138 \f}Marks the end of a formula that is in a specific environment.See alsosection \f{ and section formulas.21.139 \htmlonlyStarts a block of text that will be verbatim included in the generated HTML documentation only.
The block ends witha \endhtmlonly command.This command can be used to include HTML code that is too complex for doxygen (i.e. applets, java-scripts, andHTML tags that require attributes). You can use the \latexonly and \endlatexonly pair to provide a proper LATEXalternative.Noteenvironment variables (like $(HOME) ) are resolved inside a HTML-only block.See alsosection \manonly, section \latexonly, and section \rtfonly.21.140 \image <format> <file> [”caption”] [<sizeindication>=<size>]Inserts an image into the documentation. This command is format specific, so if you want to insert an image formore than one format you’ll have to repeat this command for each format.The first argument specifies the output format.
Currently, the following values are supported: html, latex andrtf.The second argument specifies the file name of the image. doxygen will look for files in the paths (or files) thatyou specified after the IMAGE_PATH tag. If the image is found it will be copied to the correct output directory. Ifthe image name contains spaces you’ll have to put quotes ("...") around it. You can also specify an absolute URLinstead of a file name, but then 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. Thisargument has to be specified on a single line and between quotes even if it does not contain any spaces.
Thequotes 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 usefulfor LATEX output (i.e. format=latex). The sizeindication can be either width or height. The size shouldbe a valid size specifier in LATEX (for example 10cm or 6in or a symbolic width like \textwidth).Here is example of a comment block:/*! Here is a snapshot of my new application:* \image html application.jpg* \image latex application.eps "My application" width=10cm*/And this is an example of how the relevant part of the configuration file may look:IMAGE_PATHGenerated by Doxygen= my_image_dir152Special CommandsWarningThe image format for HTML is limited to what your browser supports.
For LATEX, the image format must beEncapsulated PostScript (eps).Doxygen does not check if the image is in the correct format. So you have to make sure this is the case!21.141 \latexonlyStarts a block of text that will be verbatim included in the generated LATEX documentation only. The block ends witha \endlatexonly command.This command can be used to include LATEX code that is too complex for doxygen (i.e.
images, formulas, specialcharacters). You can use the \htmlonly and \endhtmlonly pair to provide a proper HTML alternative.Note: environment variables (like $(HOME) ) are resolved inside a LATEX-only block.See alsosection \rtfonly, section \xmlonly, section \manonly, and section \htmlonly.21.142 \manonlyStarts a block of text that will be verbatim included in the generated MAN documentation only. The block ends witha \endmanonly command.This command can be used to include groff code directly into MAN pages. You can use the \htmlonly and \latexonlyand \endhtmlonly and \endlatexonly pairs to provide proper HTML and LATEX alternatives.See alsosection \htmlonly, section \xmlonly, section \rtfonly, and section \latexonly.21.143 \li { item-description }This command has one argument that continues until the first blank line or until another \li is encountered.
Thecommand can be used to generate a simple, not nested list of arguments. Each argument should start with a \licommand.Example:Typing:\li \c AlignLeft left alignment.\li \c AlignCenter center alignment.\li \c AlignRight right alignmentNo other types of alignment are supported.will result in the following text:• AlignLeft left alignment.• AlignCenter center alignment.• AlignRight right alignmentNo other types of alignment are supported.Note:For nested lists, HTML commands should be used.Equivalent to \argGenerated by Doxygen21.144 \n15321.144 \nForces a new line. Equivalent to <br> and inspired by the printf function.21.145 \p <word>Displays the parameter <word> using a typewriter font.
You can use this command to refer to member functionparameters in the running text.Example:... the \p x and \p y coordinates are used to ...This will result in the following text:... the x and y coordinates are used to ...Equivalent to \c To have multiple words in typewriter font use <tt>multiple words</tt>.21.146 \rtfonlyStarts a block of text that will be verbatim included in the generated RTF documentation only. The block ends witha \endrtfonly command.This command can be used to include RTF code that is too complex for doxygen.Note: environment variables (like $(HOME) ) are resolved inside a RTF-only block.See alsosection \manonly, section \xmlonly, section \latexonly, and section \htmlonly.21.147 \verbatimStarts a block of text that will be verbatim included in the documentation. The block should end with a \endverbatimblock.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
