summaryrefslogtreecommitdiffstats
path: root/doc/appdev/refs/macros
Commit message (Collapse)AuthorAgeFilesLines
* Fix doc build after PKINIT responder changesGreg Hudson2013-07-181-0/+4
| | | | Add new types and constants to the apiref index files.
* Fix doc buildBen Kaduk2013-04-181-0/+1
| | | | | | The addition of the KRB5_PADATA_AS_CHECKSUM macro in d7d74867952f caused the doxygen bridge to emit a new RST file. This file was not included in the API reference toctree, causing a build failure in maintainer-mode.
* Do not document unused symbolsBen Kaduk2012-12-111-1/+0
| | | | | | | | | | | | | | | | The macro KRB5_KEYUSAGE_PA_REFERRAL was defined in an early revision of draft-ietf-krb-wg-kerberos-referrals but did not make it into RFC 6806. We retain the definition so as to not break code implementing the early draft, but need not document it. Likewise, the krb5_octet_data structure and krb5_free_octet_data routine are marked as having been originally introduced for PKINIT and "Do not use this." They are in fact unused, and should not be documented, but the actual definitions must remain for compatibility. ticket: 7489 (new) tags: pullup target_version: 1.11
* Exclude lists for doxygen API docsBen Kaduk2012-11-271-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | 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
* Rename doc subdirectoriesBen Kaduk2012-11-141-0/+369
We like these names better, and they match the PDF document filenames. admins -> admin appldev -> appdev users -> user and catch up where the names are used elsewhere. The relay/ directory has been removed, with its contents moved to the top level in build_this.rst and a new about.rst. The section headers for kadmind, krb5kdc, sserver, kpasswd, kswitch, and sclient are misdetected as conflict markers. bigredbutton: whitespace ticket: 7433 tags: pullup