[krbdev.mit.edu #7447] SVN Commit

Tom Yu via RT rt-comment at krbdev.mit.edu
Thu Nov 29 16:04:11 EST 2012


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.

(cherry picked from commit f17cc2c9edc4f36c96391d438ddeaf5bab5b2b65)

https://github.com/krb5/krb5/commit/6a743c2532656713ba947eccc822a2e26c675d01
Author: Ben Kaduk <kaduk at mit.edu>
Committer: Tom Yu <tlyu at mit.edu>
Commit: 6a743c2532656713ba947eccc822a2e26c675d01
Branch: krb5-1.11
 doc/appdev/refs/macros/index.rst |    1 -
 doc/tools/doxybuilder_funcs.py   |    4 ++++
 doc/tools/doxybuilder_types.py   |    7 +++++++
 3 files changed, 11 insertions(+), 1 deletions(-)



More information about the krb5-bugs mailing list