Skip to content

Commit

Permalink
Merge pull request #15393 from bangerth/doxygen
Browse files Browse the repository at this point in the history
Fix poor doxygen indentation choices.
  • Loading branch information
marcfehling committed Jun 21, 2023
2 parents 5ce6a12 + 8347a58 commit d3f0a4a
Showing 1 changed file with 20 additions and 1 deletion.
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

0 comments on commit d3f0a4a

Please sign in to comment.