doxygen_manual-1.8.1 (1035109), страница 34
Текст из файла (страница 34)
All visual enhancement commands may be used inside the paragraph.Multiple adjacent \invariant commands will be joined into a single paragraph. Each invariant description will start ona new line. Alternatively, one \invariant command may mention several invariants. The \invariant command endswhen a blank line or some other sectioning command is encountered.Generated by Doxygen134Special Commands21.66 \note { text }Starts a paragraph where a note can be entered. The paragraph will be indented.
The text of the paragraphhas no special internal structure. All visual enhancement commands may be used inside the paragraph. Multipleadjacent \note commands will be joined into a single paragraph. Each note description will start on a new line.Alternatively, one \note command may mention several notes. The \note command ends when a blank line or someother sectioning command is encountered. See section \par for an example.21.67 \par [(paragraph title)] { paragraph }If a paragraph title is given this command starts a paragraph with a user defined heading. The heading extends untilthe end of the line.
The paragraph following the command will be indented.If no paragraph title is given this command will start a new paragraph. This will also work inside other paragraphcommands (like \param or \warning) without ending that command.The text of the paragraph has no special internal structure. All visual enhancement commands may be used insidethe paragraph. The \par command ends when a blank line or some other sectioning command is encountered.Example:/*! \class Test* Normal text.** \par User defined paragraph:* Contents of the paragraph.** \par* New paragraph under the same heading.** \note* This note consists of two paragraphs.* This is the first paragraph.** \par* And this is the second paragraph.** More normal text.*/class Test {};21.68 \param [(dir)] <parameter-name> { parameter description }Starts a parameter description for a function parameter with name <parameter-name>, followed by a descriptionof the parameter.
The existence of the parameter is checked and a warning is given if the documentation of this (orany other) parameter is missing or not present in the function declaration or definition.The \param command has an optional attribute, (dir), specifying the direction of the parameter. Possible valuesare "[in]", "[in,out]", and "[out]", note the [square] brackets in this description. When a parameter is both input andoutput, [in,out] is used as attribute. Here is an example for the function memcpy:\textcolor{comment}{/*!}\textcolor{comment}{ Copies bytes from a source memory area to a destination memory area,}\textcolor{comment}{ where both areas may not overlap.}\textcolor{comment}{ @param[out] dest The memory area to copy to.}\textcolor{comment}{ @param[in] src The memory area to copy from.}\textcolor{comment}{ @param[in] nThe number of bytes to copy}\textcolor{comment}{ */}\textcolor{keywordtype}{void} memcpy(\textcolor{keywordtype}{void} *dest, \textcolor{keyword}{const} \textcoloThe parameter description is a paragraph with no special internal structure.
All visual enhancement commands maybe used inside the paragraph.Generated by Doxygen21.69 \tparam <template-parameter-name> { description }135Multiple adjacent \param commands will be joined into a single paragraph. Each parameter description will start ona new line. The \param description ends when a blank line or some other sectioning command is encountered. Seesection \fn for an example.Note that you can also document multiple parameters with a single \param command using a comma separated list.Here is an example:\textcolor{comment}{/** Sets the position.}\textcolor{comment}{ @param x,y,z Coordinates of the position in 3D space.}\textcolor{comment}{ */}\textcolor{keywordtype}{void} setPosition(\textcolor{keywordtype}{double} x,\textcolor{keywordtype}{double} y,\{\}Note that for PHP one can also specify the type (or types if you separate them with a pipe symbol) which are allowedfor a parameter (as this is not part of the definition).
The syntax is the same as for phpDocumentor, i.e.@paramdatatype1|datatype2 $paramname description21.69 \tparam <template-parameter-name> { description }Starts a template parameter for a class or function template parameter with name <template-parameter-name>,followed by a description of the template parameter.Otherwise similar to \param.21.70 \post { description of the postcondition }Starts a paragraph where the postcondition of an entity can be described.
The paragraph will be indented. Thetext of the paragraph has no special internal structure. All visual enhancement commands may be used inside theparagraph. Multiple adjacent \post commands will be joined into a single paragraph. Each postcondition will starton a new line. Alternatively, one \post command may mention several postconditions. The \post command endswhen a blank line or some other sectioning command is encountered.21.71 \pre { description of the precondition }Starts a paragraph where the precondition of an entity can be described.
The paragraph will be indented. Thetext of the paragraph has no special internal structure. All visual enhancement commands may be used inside theparagraph. Multiple adjacent \pre commands will be joined into a single paragraph. Each precondition will start ona new line. Alternatively, one \pre command may mention several preconditions. The \pre command ends when ablank line or some other sectioning command is encountered.21.72 \remark { remark text }Starts a paragraph where one or more remarks may be entered.
The paragraph will be indented. The text of theparagraph has no special internal structure. All visual enhancement commands may be used inside the paragraph.Multiple adjacent \remark commands will be joined into a single paragraph. Each remark will start on a new line.Alternatively, one \remark command may mention several remarks. The \remark command ends when a blank lineor some other sectioning command is encountered.21.73 \remarks { remark text }Equivalent to \remark.Generated by Doxygen136Special Commands21.74 \result { description of the result value }Equivalent to \return.21.75 \return { description of the return value }Starts a return value description for a function.
The text of the paragraph has no special internal structure. Allvisual enhancement commands may be used inside the paragraph. Multiple adjacent \return commands will bejoined into a single paragraph. The \return description ends when a blank line or some other sectioning commandis encountered. See section \fn for an example.21.76 \returns { description of the return value }Equivalent to \return.21.77 \retval <return value> { description }Starts a description for a function’s return value with name <return value>, followed by a description of the returnvalue.
The text of the paragraph that forms the description has no special internal structure. All visual enhancementcommands may be used inside the paragraph. Multiple adjacent \retval commands will be joined into a singleparagraph. Each return value description will start on a new line. The \retval description ends when a blank line orsome other sectioning command is encountered.21.78 \sa { references }Starts a paragraph where one or more cross-references to classes, functions, methods, variables, files or URL maybe specified. Two names joined by either :: or # are understood as referring to a class and one of its members.One of several overloaded methods or constructors may be selected by including a parenthesized list of argumenttypes after the method name.Synonymous to \see.See alsosection autolink for information on how to create links to objects.21.79 \see { references }Equivalent to \sa.
Introduced for compatibility with Javadoc.21.80 \short { short description }Equivalent to \brief.Generated by Doxygen21.81 \since { text }13721.81 \since { text }This tag can be used to specify since when (version or time) an entity is available. The paragraph that follows \sincedoes not have any special internal structure. All visual enhancement commands may be used inside the paragraph.The \since description ends when a blank line or some other sectioning command is encountered.21.82 \test { paragraph describing a test case }Starts a paragraph where a test case can be described.
The description will also add the test case to a separatetest list. The two instances of the description will be cross-referenced. Each test case in the test list will be precededby a header that indicates the origin of the test case.21.83 \throw <exception-object> { exception description }Synonymous to \exception (see section \exception).Note:the tag \throws is a synonym for this tag.See alsosection \exception21.84 \throws <exception-object> { exception description }Equivalent to \throw.21.85 \todo { paragraph describing what is to be done }Starts a paragraph where a TODO item is described. The description will also add an item to a separate TODOlist.
The two instances of the description will be cross-referenced. Each item in the TODO list will be preceded by aheader that indicates the origin of the item.21.86 \version { version number }Starts a paragraph where one or more version strings may be entered. The paragraph will be indented. The textof the paragraph has no special internal structure. All visual enhancement commands may be used inside theparagraph. Multiple adjacent \version commands will be joined into a single paragraph.
![](https://s.studizba.com/z.php?f=/templates/si/i/noavatar.png&w=100&h=100&t=1"){kind=avatar}
