doxygen_manual-1.8.1 (1035109), страница 36
Текст из файла (страница 36)
For this to work thefragment has to be marked.NoteDoxygen’s special commands do not work inside blocks of code. It is allowed to nest C-style comments insidea code block though.See alsosections \example, \dontinclude, and \verbatim.21.103 \includelineno <file-name>This command works the same way as \include, but will add line numbers to the included file.See alsosection \include.21.104 \line ( pattern )This command searches line by line through the example that was last included using \include or \dontinclude untilit finds a non-blank line. If that line contains the specified pattern, it is written to the output.The internal pointer that is used to keep track of the current line in the example, is set to the start of the line followingthe non-blank line that was found (or to the end of the example if no such line could be found).See section \dontinclude for an example.Generated by Doxygen21.105 \skip ( pattern )14321.105 \skip ( pattern )This command searches line by line through the example that was last included using \include or \dontinclude untilit finds a line that contains the specified pattern.The internal pointer that is used to keep track of the current line in the example, is set to the start of the line thatcontains the specified pattern (or to the end of the example if the pattern could not be found).See section \dontinclude for an example.21.106 \skipline ( pattern )This command searches line by line through the example that was last included using \include or \dontinclude untilit finds a line that contains the specified pattern.
It then writes the line to the output.The internal pointer that is used to keep track of the current line in the example, is set to the start of the line followingthe line that is written (or to the end of the example if the pattern could not be found).Note:The command:\skipline patternis equivalent to:\skip pattern\line patternSee section \dontinclude for an example.21.107 \snippet <file-name> ( block id )Where the \include command can be used to include a complete file as source code, this command can be used toquote only a fragment of a source file.For example, the putting the following command in the documentation, references a snippet in file example.cppresiding in a subdirectory which should be pointed to by EXAMPLE_PATH.\snippet snippets/example.cpp Adding a resourceThe text following the file name is the unique identifier for the snippet. This is used to delimit the quoted code in therelevant snippet file as shown in the following example that corresponds to the above \snippet command:QImage image(64, 64, QImage::Format\_RGB32);image.fill(qRgb(255, 160, 128));\textcolor{comment}{}\textcolor{comment}{//! [Adding a resource]}\textcolor{comment}{}document->addResource(QTextDocument::ImageResource,QUrl(\textcolor{stringliteral}{"mydata://image.png"}), QVariant(image));\textcolor{comment}{}\textcolor{comment}{//! [Adding a resource]}\textcolor{comment}{}...Note that the lines containing the block markers will not be included, so the output will be:document->addResource(QTextDocument::ImageResource,QUrl(\textcolor{stringliteral}{"mydata://image.png"}), QVariant(image));Note also that the [block_id] markers should appear exactly twice in the source file.see section \dontinclude for an alternative way to include fragments of a source file that does not require markers.Generated by Doxygen144Special Commands21.108 \until ( pattern )This command writes all lines of the example that was last included using \include or \dontinclude to the output, untilit finds a line containing the specified pattern.
The line containing the pattern will be written as well.The internal pointer that is used to keep track of the current line in the example, is set to the start of the line followinglast written line (or to the end of the example if the pattern could not be found).See section \dontinclude for an example.21.109 \verbinclude <file-name>This command includes the file <file-name> verbatim in the documentation. The command is equivalent to pastingthe file in the documentation and placing \verbatim and \endverbatim commands around it.Files or directories that doxygen should look for can be specified using the EXAMPLE_PATH tag of doxygen’sconfiguration file.21.110 \htmlinclude <file-name>This command includes the file <file-name> as is in the HTML documentation. The command is equivalent topasting the file in the documentation and placing \htmlonly and \endhtmlonly commands around it.Files or directories that doxygen should look for can be specified using the EXAMPLE_PATH tag of doxygen’sconfiguration file.Commands for visual enhancements21.111 \a <word>Displays the argument <word> in italics.
Use this command to emphasize words. Use this command to refer tomember arguments in the running text.Example:... the \a x and \a y coordinates are used to ...This will result in the following text:... the x and y coordinates are used to ...Equivalent to \e and \em. To emphasize multiple words use <em>multiple words</em>.21.112 \arg { item-description }This command has one argument that continues until the first blank line or until another \arg is encountered. Thecommand can be used to generate a simple, not nested list of arguments. Each argument should start with a \argcommand.Example:Typing:\arg \c AlignLeft left alignment.\arg \c AlignCenter center alignment.\arg \c AlignRight right alignmentNo other types of alignment are supported.Generated by Doxygen21.113 \b <word>145will 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 \li21.113 \b <word>Displays the argument <word> using a bold font.
Equivalent to <b>word</b>. To put multiple words in bold use<b>multiple words</b>.21.114 \c <word>Displays the argument <word> using a typewriter font. Use this to refer to a word of code. Equivalent to<tt>word</tt>.Example:Typing:... This function returns \c void and not \c int ...will result in the following text:... This function returns void and not int ...Equivalent to \p To have multiple words in typewriter font use <tt>multiple words</tt>.21.115 \code [ ’{’<word>’}’]Starts a block of code. A code block is treated differently from ordinary text. It is interpreted as source code.The names of classes and members and other documented entities are automatically replaced by links to thedocumentation.By default the language that is assumed for syntax highlighting is based on the location where the \code block wasfound.
If this part of a Python file for instance, the syntax highlight will be done according to the Python syntax.If it unclear from the context which language is meant (for instance the comment is in a .txt or .markdown file) thenyou can also explicitly indicate the language, by putting the file extension typically that doxygen associated with thelanguage in curly brackets after the code block. Here is an example:\code{.py}class Python:pass\endcode\code{.cpp}class Cpp {};\endcodeSee alsosection \endcode and section \verbatim.Generated by Doxygen146Special Commands21.116 \copydoc <link-object>Copies a documentation block from the object specified by <link-object> and pastes it at the location of the command. This command can be useful to avoid cases where a documentation block would otherwise have to beduplicated or it can be used to extend the documentation of an inherited member.The link object can point to a member (of a class, file or group), a class, a namespace, a group, a page, or afile (checked in that order).
Note that if the object pointed to is a member (function, variable, typedef, etc), thecompound (class, file, or group) containing it should also be documented for the copying to work.To copy the documentation for a member of a class one can, for instance, put the following in the documentation:/*! @copydoc MyClass::myfunction()* More documentation.*/if the member is overloaded, you should specify the argument types explicitly (without spaces!), like in the following://! @copydoc MyClass::myfunction(type1,type2)Qualified names are only needed if the context in which the documentation block is found requires them.The \copydoc command can be used recursively, but cycles in the \copydoc relation will be broken and flagged asan error.Note that \copydoc foo() is roughly equivalent to doing:\brief \copybrief foo()\details \copydetails foo()See \copybrief and \copydetails for copying only the brief or detailed part of the comment block.21.117 \copybrief <link-object>Works in a similar way as \copydoc but will only copy the brief description, not the detailed documentation.21.118 \copydetails <link-object>Works in a similar way as \copydoc but will only copy the detailed documentation, not the brief description.21.119 \dotStarts a text fragment which should contain a valid description of a dot graph.
The text fragment ends with \enddot.Doxygen will pass the text on to dot and include the resulting image (and image map) into the output. The nodesof a graph can be made clickable by using the URL attribute. By using the command \ref inside the URL value youcan conveniently link to an item inside doxygen. Here is an example:\textcolor{comment}{/*! class B */}\textcolor{keyword}{class }B \{\};\textcolor{comment}{}\textcolor{comment}{/*! class C */}\textcolor{keyword}{class }C \{\};\textcolor{comment}{}\textcolor{comment}{/*! \(\backslash\)mainpage}\textcolor{comment}{}\textcolor{comment}{ Class relations expressed via an inline dot graph:}\textcolor{comment}{ \(\backslash\)dot}\textcolor{comment}{ digraph example \{}Generated by Doxygen21.120 \msc147\textcolor{comment}{node [shape=record, fontname=Helvetica, fontsize=10];}\textcolor{comment}{b [ label="class B" URL="\(\backslash\)ref B"];}\textcolor{comment}{c [ label="class C" URL="\(\backslash\)ref C"];}\textcolor{comment}{b -> c [ arrowhead="open", style="dashed" ];}\textcolor{comment}{ \}}\textcolor{comment}{ \(\backslash\)enddot}\textcolor{comment}{ Note that the classes in the above graph are clickable}\textcolor{comment}{ (in the HTML output).}\textcolor{comment}{ */}21.120 \mscStarts a text fragment which should contain a valid description of a message sequence chart.
See http://www.mcternan.me.uk/mscgen/ for examples. The text fragment ends with \endmsc.NoteThe text fragment should only include the part of the message sequence chart that is within the msc {...}block.You need to install the mscgen tool, if you want to use this command.Here is an example of the use of the \msc command.\textcolor{comment}{/** Sender class. Can be used to send a command to the server.}\textcolor{comment}{ The receiver will acknowledge the command by calling Ack().}\textcolor{comment}{ \(\backslash\)msc}\textcolor{comment}{Sender,Receiver;}\textcolor{comment}{Sender->Receiver [label="Command()", URL="\(\backslash\)ref Receiver::Command()"];}\textcolor{comment}{Sender<-Receiver [label="Ack()", URL="\(\backslash\)ref Ack()", ID="1"];}\textcolor{comment}{ \(\backslash\)endmsc}\textcolor{comment}{ */}\textcolor{keyword}{class }Sender\{\textcolor{keyword}{public}:\textcolor{comment}{}\textcolor{comment}{/** Acknowledgement from server */}\textcolor{keywordtype}{void} Ack(\textcolor{keywordtype}{bool} ok);\};\textcolor{comment}{}\textcolor{comment}{/** Receiver class.
Can be used to receive and execute commands.}\textcolor{comment}{ After execution of a command, the receiver will send an acknowledgement}\textcolor{comment}{ \(\backslash\)msc}\textcolor{comment}{Receiver,Sender;}\textcolor{comment}{Receiver<-Sender [label="Command()", URL="\(\backslash\)ref Command()"];}\textcolor{comment}{Receiver->Sender [label="Ack()", URL="\(\backslash\)ref Sender::Ack()", ID="1"];}\textcolor{comment}{ \(\backslash\)endmsc}\textcolor{comment}{ */}\textcolor{keyword}{class }Receiver\{\textcolor{keyword}{public}:\textcolor{comment}{}\textcolor{comment}{/** Executable a command on the server */}\textcolor{keywordtype}{void} Command(\textcolor{keywordtype}{int} commandId);\};See alsosection \mscfile.21.121 \dotfile <file> [”caption”]Inserts an image generated by dot from <file> into the documentation.The first argument specifies the file name of the image.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
