]> git.ipfire.org Git - thirdparty/krb5.git/commit
Exclude lists for doxygen API docs
authorBen Kaduk <kaduk@mit.edu>
Wed, 21 Nov 2012 16:31:06 +0000 (11:31 -0500)
committerBen Kaduk <kaduk@mit.edu>
Tue, 27 Nov 2012 22:52:54 +0000 (17:52 -0500)
commitf17cc2c9edc4f36c96391d438ddeaf5bab5b2b65
tree59b1dbc64c56671d4129ddacf79adb2275528410
parent484ac9228b317b96a81c9e88778c521c54d49213
Exclude lists for doxygen API docs

Doxygen will pick up every function, macro, and typedef defined
in krb5.h; some of these may not actually be part of the public
API for one reason or another.  Provide hardcoded exclude lists
for macro/function/type names for which we do not want to emit
reStructuredText documentation, and check these lists when processing
the Doxygen XML output.

Seed these lists with the macros TRUE, FALSE, KRB5_OLD_CRYPTO,
KRB5_GENERAL__, KRB5_CALLCONV, KRB5_CALLCONV_C, KRB5_CALLCONV_WRONG,
KRB5INT_BEGIN_DECLS, KRB5INT_END_DECLS, and KRB5_ATTR_DEPRECATED,
and typedefs krb5_cc_ops and krb5_responder_context. The booleans
are compatibility cruft that we do not want to advertise, and the other
macros are for internal use for signalling and platform compatibility.
The typedefs are functioning just as forward declarations.

For consistency, remove KRB5_OLD_CRYPTO.rst from the macros index; it
had no content even when we did generate it.

ticket: 7447
tags: pullup
target_version: 1.11
doc/appdev/refs/macros/index.rst
doc/tools/doxybuilder_funcs.py
doc/tools/doxybuilder_types.py