Changeset 104e881 in mod_gnutls for src/gnutls_ocsp.h


Ignore:
Timestamp:
Dec 6, 2016, 2:13:55 AM (3 years ago)
Author:
Thomas Klute <thomas2.klute@…>
Branches:
debian/master, debian/stretch-backports, master, upstream
Children:
e0e0b0f
Parents:
14548b9
Message:

General comment updates for Doxygen compatibility

Mostly /* */ vs. / */ changes so Doxygen does catch the correct
descriptions instead of e.g. license headers, plus some minor comment
updates.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/gnutls_ocsp.h

    r14548b9 r104e881  
    1 /**
     1/*
    22 *  Copyright 2016 Thomas Klute
    33 *
     
    2525#define MGS_OCSP_MUTEX_NAME "gnutls-ocsp"
    2626
    27 /* Default OCSP response cache timeout in seconds */
     27/** Default OCSP response cache timeout in seconds */
    2828#define MGS_OCSP_CACHE_TIMEOUT 3600
    29 /* Default OCSP failure timeout in seconds */
     29/** Default OCSP failure timeout in seconds */
    3030#define MGS_OCSP_FAILURE_TIMEOUT 300
    31 /* Default socket timeout for OCSP responder connections, in
     31/** Default socket timeout for OCSP responder connections, in
    3232 * seconds. Note that the timeout applies to "absolutely no data sent
    3333 * or received", not the whole connection. 10 seconds in mod_ssl. */
     
    3838 */
    3939struct mgs_ocsp_data {
    40     /* OCSP URI extracted from the server certificate. NULL if
     40    /** OCSP URI extracted from the server certificate. NULL if
    4141     * unset. */
    4242    apr_uri_t *uri;
    43     /* Trust list to verify OCSP responses for stapling. Should
     43    /** Trust list to verify OCSP responses for stapling. Should
    4444     * usually only contain the CA that signed the server
    4545     * certificate. */
    4646    gnutls_x509_trust_list_t *trust;
    47     /* Server certificate fingerprint, used as cache key for the OCSP
     47    /** Server certificate fingerprint, used as cache key for the OCSP
    4848     * response */
    4949    gnutls_datum_t fingerprint;
     
    6262                                         const char *arg);
    6363
    64 /*
     64/**
    6565 * Create a trust list from a certificate chain (one or more
    6666 * certificates).
    6767 *
    68  * tl: This trust list will be initialized and filled with the
     68 * @param tl This trust list will be initialized and filled with the
    6969 * specified certificate(s)
    7070 *
    71  * chain: certificate chain, must contain at least num certifictes
     71 * @param chain certificate chain, must contain at least `num`
     72 * certifictes
    7273 *
    73  * num: number of certificates to load from chain
     74 * @param num number of certificates to load from chain
    7475 *
    7576 * Chain is supposed to be static (the trust chain of the server
    76  * certificate), so when gnutls_x509_trust_list_deinit() is called on
     77 * certificate), so when `gnutls_x509_trust_list_deinit()` is called on
    7778 * tl later, the "all" parameter should be zero.
    7879 *
    79  * Returns GNUTLS_E_SUCCESS or a GnuTLS error code. In case of error
     80 * @return `GNUTLS_E_SUCCESS` or a GnuTLS error code. In case of error
    8081 * tl will be uninitialized.
    8182 */
Note: See TracChangeset for help on using the changeset viewer.