[krbdev.mit.edu #7447] SVN Commit

[Benjamin Kaduk via RT]

Render macros as literals

Some convenience macros are referring to and dereferencing pointers,
and Sphinx will get a bit confused trying to interpret this as markup.
There should never be any markup intended to be interpreted in the
value of a macro definition, so we can silence this class of
warnings by treating them as literals.  (In some sense, they actually
are literals, too.)

This will cause a warning for macros that only cause a
symbol to be defined, that is, a literal "#define MACRO" with no
initializer, due to the lack of body in the inline-literal markup.
Such macros should probably be added to the exclude list for conversion
to reStructuredText in the Doxygen-Sphinx bridge, as was already
done for KRB5_OLD_CRYPTO.  Support code to programmatically omit
macros of this sort is deliberately *not* included, so that explicit
action must be taken when a new macro is to be undocumented.

Also, strip leading and trailing whitespace from the macro name,
since this causes problems with the markup.

https://github.com/krb5/krb5/commit/94947241bd347e9b4dd729c5d550150b7e8cd64c
Author: Ben Kaduk <kaduk at mit.edu>
Commit: 94947241bd347e9b4dd729c5d550150b7e8cd64c
Branch: master
 doc/tools/define_document.tmpl |   12 ++++++------
 doc/tools/doxybuilder_types.py |    2 +-
 2 files changed, 7 insertions(+), 7 deletions(-)