Skip to content

Commit 2706c0a

Browse files
committed
Some rephrasing
Signed-off-by: eduponz <eduardoponz@eprosima.com>
1 parent 810e327 commit 2706c0a

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

doc/commands.dox

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2066,8 +2066,11 @@ ALIASES = "english=\if english" \
20662066
present in the function declaration or definition.
20672067

20682068
The \c \\param command has an optional attribute, \<dir\>, specifying the direction
2069-
of the parameter. Possible values are "[in]", "[out]", "[inout]", "[outin]",
2070-
"[in,out]", "[out,in]", "[in out]", and "[out in]"; note the [square] brackets in this description.
2069+
of the parameter. Possible values are "[in]", "[out]", and "[in,out]"; note the [square] brackets
2070+
in this description.
2071+
For the bidirecional values, directions "in" and "out" can be specified in any order, and they can
2072+
either be written altogether, or separated with a comma (`,`) or a space.
2073+
That means that for example values "[outin]" or "[in out]" are also valid.
20712074
Note that it is also possible to put whitespace between the command and the \<dir\>.
20722075
When a parameter is both input and output, [in,out] is used as attribute.
20732076
Here is an example for the function \c memcpy:

0 commit comments

Comments
 (0)