Skip to content
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

Fix poor doxygen indentation choices. #15393

Merged
merged 1 commit into from
Jun 21, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 20 additions & 1 deletion doc/doxygen/scripts/program2doxygen
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,26 @@ do {
# meaning somehow, but I don't know how...)
s/\$//g;

print " * $_";
# Then print the line. doxygen has the annoying habit of eating
# the maximal number of spaces at the front of each code block,
# leading to visually wrong indentation if one, for example, has
# ```
# if (cond)
# {
# ```
# in one block, and then
# ```
# some_function();
# ```
# in the next block -- the call to some_function() is not shown any
# further to the right than the if(cond) before. Work around this by
# prefixing all code lines with a non-printing Unicode space 0x00A0
# that doxygen interprets as the first non-space character for
# determining indentation, but that does not actually print as anything
# other than a space (and that compilers appear to successfully ignore
# when one copy-pastes code snippets from the generated doxygen pages
# into an editor).
print " *   $_"; # Note the (invisible) Unicode space after the '* '
}
elsif ($state == $skip_mode)
{
Expand Down