-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Inconsistencies on use of separating space before an [ or { in documentation and examples #10823
Comments
There are some different meanings regarding the
Regarding the inconsistent behaviors:
|
… an [ or { in documentation and examples Making `\param`, `\htmlonly` and `\htmlinclude` bit more consistent
I've just pushed a proposed patch, pull request #10824 |
@albert-github, thanks for taking care of this. I fully understand the difference in However, looking at the proposed #10824 I question adding the separating space after
|
I just made the documentation consistent with the current code. but it is possible to make the |
I just checked the code base and the syntax with the possible space is present since release 1.3.7 (May 7, 2004), before the direction was not supported. |
@albert-github The space between |
I have quickly performed a search accross Doxygen's code base. Here is what I have found: with space: 2 occurrences
without space: 167 occurrences
It's pretty clear that Doxygen's standard is without a space, but the parser is flexible enough to also accept a space. |
I cannot agree with the conclusion:
Doxygen has no problem with either the versions with and without spaces, also seen the rule:
as used in The From the "167 occurrences" it is to me only clear that doxygen prefers for its documentation the version without the space. So probably better to remove the spape in the docu and make the fact that the space is possible just a note. (I didn't read the comment from @doxygen, #10823 (comment) before writing this comment. I missed it) |
… an [ or { in documentation and examples After review
issue #10823 Inconsistencies on use of separating space before an [ or { in documentation and examples
Code has been integrated in master on GitHub (please don't close the issue as this will be done at the moment of an official release). |
@albert-github, thanks! |
This issue was previously marked 'fixed but not released', |
Describe the bug
Inconsistent:
@param[out]
isn't.\htmlinclude[block]
isn't.Consistent:
\code{.py}
.\include{doc,raise=1} file.dox
Screenshots
n/a, see links.
To Reproduce
n/a, see links.
Expected behavior
Consistent documentation and examples, giving users consistent guidance on how Doxygen syntax is intended to be used.
Version
n/a, see links.
Stack trace
n/a, see links.
Additional context
n/a, see links.
Please let me know the Doxygen preference and I'll supply a PR for this.
The text was updated successfully, but these errors were encountered: