45
21.54 \post { description of the postcondition }
95
void memcpy(void
*
dest, const void
*
src, size_t n);
If a parameter is both input and output, use [in,out] as an attribute.
The parameter description is a paragraph with no special internal structure. All visual enhancement com-
mands may be used inside the paragraph.
Multiple adjacent \param commands will be joined into a single paragraph. Each parameter description
will start on a new line. The \param description ends when a blank line or some other sectioning command
is encountered. See section\fn for an example.
21.54 \post { description of the postcondition }
Starts a paragraph where the postcondition of an entity can be described. The paragraph will be indented.
The text of the paragraph has no special internal structure. All visual enhancement commands may be used
inside the paragraph. Multiple adjacent \post commands will be joined into a single paragraph. Each post-
condition will start on a new line. Alternatively, one \post command may mention several postconditions.
The \post command ends when a blank line or some other sectioning command is encountered.
21.55 \pre { description of the precondition }
Starts a paragraph where the precondition of an entity can be described. The paragraph will be indented.
The text of the paragraph has no special internal structure. All visual enhancement commands may be
used inside the paragraph. Multiple adjacent \pre commands will be joined into a single paragraph. Each
precondition will start on a new line. Alternatively, one \pre command may mention several preconditions.
The \pre command ends when a blank line or some other sectioning command is encountered.
21.56 \remarks { remark text }
Starts a paragraph where one or more remarks may be entered. The paragraph will be indented. The text
of the paragraph 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 line or some other sectioning command is encountered.
21.57 \return { description of the return value }
Starts a return value description for a function. The text of the paragraph has no special internal structure.
All visual enhancement commands may be used insidetheparagraph. Multipleadjacent \return commands
will be joined into a single paragraph. The \return description ends when a blank line or some other
sectioning command is encountered. See section\fn for an example.
21.58 \retval <return value> { description }
Starts a return value description for a function with name <return value>. Followed by a description of
the return value. The text of the paragraph that forms the description has no special internal structure. All
visual enhancement commands may be used inside the paragraph. Multiple adjacent \retval commands
will be joined into a single paragraph. Each return value description will start on a new line. The \retval
description ends when a blank line or some other sectioning command is encountered.
User Manual forDoxygen1.5.3,written by Dimitri vanHeesch
c
1997-2006