summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorBen Kaduk <kaduk@mit.edu>2012-11-16 19:48:55 -0500
committerBen Kaduk <kaduk@mit.edu>2012-11-27 17:55:03 -0500
commit94947241bd347e9b4dd729c5d550150b7e8cd64c (patch)
tree2442b97c8fdf42ba1371b72798ceaeecfe4597b2 /src
parent760155906bc47163bac1fb5622034a9d53e15294 (diff)
downloadkrb5-94947241bd347e9b4dd729c5d550150b7e8cd64c.tar.gz
krb5-94947241bd347e9b4dd729c5d550150b7e8cd64c.tar.xz
krb5-94947241bd347e9b4dd729c5d550150b7e8cd64c.zip
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. ticket: 7447 tags: pullup target_version: 1.11
Diffstat (limited to 'src')
0 files changed, 0 insertions, 0 deletions