Skip to content

Commit

Permalink
Merge pull request #10824 from albert-github/feature/issue_10823
Browse files Browse the repository at this point in the history
issue #10823 Inconsistencies on use of separating space before an [ or { in documentation and examples
  • Loading branch information
doxygen committed Apr 28, 2024
2 parents c7f6924 + 0fb7ecc commit 47dd7f5
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions doc/commands.dox
Original file line number Diff line number Diff line change
Expand Up @@ -2056,7 +2056,7 @@ ALIASES = "english=\if english" \
\endlatexonly

<hr>
\section cmdparam \\param '['dir']' <parameter-name> { parameter description }
\section cmdparam \\param[\<dir\>] <parameter-name> { parameter description }

\addindex \\param
Starts a parameter description for a function parameter with name
Expand All @@ -2065,9 +2065,10 @@ ALIASES = "english=\if english" \
the documentation of this (or any other) parameter is missing or not
present in the function declaration or definition.

The \c \\param command has an optional attribute, `dir`, specifying the direction
The \c \\param command has an optional attribute, \<dir\>, specifying the direction
of the parameter. Possible values are "[in]", "[in,out]", and "[out]",
note the [square] brackets in this description.
note the [square] brackets in this description. Note that it is also possible to put
whitespace between the command and the \<dir\>.
When a parameter is both input and output, [in,out] is used as attribute.
Here is an example for the function \c memcpy:
\code
Expand Down Expand Up @@ -2989,7 +2990,7 @@ Commands for displaying examples
\ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file.

<hr>
\section cmdhtmlinclude \\htmlinclude ["[block]"] <file-name>
\section cmdhtmlinclude \\htmlinclude['[block]'] <file-name>

\addindex \\htmlinclude
This command includes the contents of the file \<file-name\> as is in the HTML documentation
Expand Down Expand Up @@ -3830,7 +3831,7 @@ class Receiver
\sa section \ref cmdfcurlyopen "\\f{" and section \ref formulas "formulas".

<hr>
\section cmdhtmlonly \\htmlonly ["[block]"]
\section cmdhtmlonly \\htmlonly['[block]']

\addindex \\htmlonly
Starts a block of text that only will be verbatim included in the
Expand Down

0 comments on commit 47dd7f5

Please sign in to comment.