Skip to content

Commit

Permalink
Various fixes to doxygen API generation
Browse files Browse the repository at this point in the history
 * Fixed incorrect file definitions
 * Fixed accidental tag problems in ecjpake.h
 * Corrected function naming in X.509 module definition
  • Loading branch information
simonbutcher committed Jan 3, 2016
1 parent 9803d07 commit 5b331b9
Show file tree
Hide file tree
Showing 15 changed files with 33 additions and 31 deletions.
24 changes: 13 additions & 11 deletions doxygen/input/doc_x509.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,20 @@
/**
* @addtogroup x509_module X.509 module
*
* The X.509 module provides X.509 support which includes:
* - X.509 certificate (CRT) reading (see \c x509parse_crt() and
* \c x509parse_crtfile()).
* - X.509 certificate revocation list (CRL) reading (see \c x509parse_crl()
* and\c x509parse_crlfile()).
* - X.509 (RSA and ECC) private key reading (see \c x509parse_key() and
* \c x509parse_keyfile()).
* - X.509 certificate signature verification (see \c x509parse_verify())
* - X.509 certificate writing and certificate request writing (see
* \c mbedtls_x509write_crt_der() and \c mbedtls_x509write_csr_der()).
* The X.509 module provides X.509 support for reading, writing and verification
* of certificates.
* In summary:
* - X.509 certificate (CRT) reading (see \c mbedtls_x509_crt_parse(),
* \c mbedtls_x509_crt_parse_der(), \c mbedtls_x509_crt_parse_file()).
* - X.509 certificate revocation list (CRL) reading (see
* \c mbedtls_x509_crl_parse(), \c mbedtls_x509_crl_parse_der(),
* and \c mbedtls_x509_crl_parse_file()).
* - X.509 certificate signature verification (see \c
* mbedtls_x509_crt_verify() and \c mbedtls_x509_crt_verify_with_profile().
* - X.509 certificate writing and certificate request writing (see
* \c mbedtls_x509write_crt_der() and \c mbedtls_x509write_csr_der()).
*
* This module can be used to build a certificate authority (CA) chain and
* verify its signature. It is also used to generate Certificate Signing
* Requests and X509 certificates just as a CA would do.
* Requests and X.509 certificates just as a CA would do.
*/
5 changes: 3 additions & 2 deletions include/mbedtls/compat-1.3.h
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
/**
* \file config.h
* \file compat-1.3.h
*
* \brief Compatibility names (set of defines)
* \brief Compatibility definitions for using mbed TLS with client code written
* for the PolarSSL naming conventions.
*
* \deprecated Use the new names directly instead
*
Expand Down
9 changes: 4 additions & 5 deletions include/mbedtls/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
*
* \brief Configuration options (set of defines)
*
* This set of compile-time options may be used to enable
* or disable features selectively, and reduce the global
* memory footprint.
*
* Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
* SPDX-License-Identifier: Apache-2.0
*
Expand All @@ -21,11 +25,6 @@
* This file is part of mbed TLS (https://tls.mbed.org)
*/

/*
* This set of compile-time options may be used to enable
* or disable features selectively, and reduce the global
* memory footprint.
*/
#ifndef MBEDTLS_CONFIG_H
#define MBEDTLS_CONFIG_H

Expand Down
2 changes: 1 addition & 1 deletion include/mbedtls/ecjpake.h
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ typedef enum {
*
* In order to benefit from this symmetry, we choose a different naming
* convetion from the Thread v1.0 spec. Correspondance is indicated in the
* description as a pair C: <client name>, S: <server name>
* description as a pair C: client name, S: server name
*/
typedef struct
{
Expand Down
2 changes: 1 addition & 1 deletion include/mbedtls/md.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file mbedtls_md.h
* \file md.h
*
* \brief Generic message digest wrapper
*
Expand Down
2 changes: 1 addition & 1 deletion include/mbedtls/md2.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file mbedtls_md2.h
* \file md2.h
*
* \brief MD2 message digest algorithm (hash function)
*
Expand Down
2 changes: 1 addition & 1 deletion include/mbedtls/md4.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file mbedtls_md4.h
* \file md4.h
*
* \brief MD4 message digest algorithm (hash function)
*
Expand Down
2 changes: 1 addition & 1 deletion include/mbedtls/md5.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file mbedtls_md5.h
* \file md5.h
*
* \brief MD5 message digest algorithm (hash function)
*
Expand Down
2 changes: 1 addition & 1 deletion include/mbedtls/ripemd160.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file mbedtls_ripemd160.h
* \file ripemd160.h
*
* \brief RIPE MD-160 message digest
*
Expand Down
2 changes: 1 addition & 1 deletion include/mbedtls/sha1.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file mbedtls_sha1.h
* \file sha1.h
*
* \brief SHA-1 cryptographic hash function
*
Expand Down
2 changes: 1 addition & 1 deletion include/mbedtls/sha256.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file mbedtls_sha256.h
* \file sha256.h
*
* \brief SHA-224 and SHA-256 cryptographic hash function
*
Expand Down
2 changes: 1 addition & 1 deletion include/mbedtls/sha512.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file mbedtls_sha512.h
* \file sha512.h
*
* \brief SHA-384 and SHA-512 cryptographic hash function
*
Expand Down
4 changes: 2 additions & 2 deletions include/mbedtls/x509_crl.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file mbedtls_x509_crl.h
* \file x509_crl.h
*
* \brief X.509 certificate revocation list parsing
*
Expand Down Expand Up @@ -100,7 +100,7 @@ mbedtls_x509_crl;
*
* \param chain points to the start of the chain
* \param buf buffer holding the CRL data in DER format
* (including the terminating null byte for PEM data)
* \param buflen size of the buffer
*
* \return 0 if successful, or a specific X509 or PEM error code
*/
Expand Down
2 changes: 1 addition & 1 deletion include/mbedtls/x509_crt.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file mbedtls_x509_crt.h
* \file x509_crt.h
*
* \brief X.509 certificate parsing and writing
*
Expand Down
2 changes: 1 addition & 1 deletion include/mbedtls/x509_csr.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file mbedtls_x509_csr.h
* \file x509_csr.h
*
* \brief X.509 certificate signing request parsing and writing
*
Expand Down

0 comments on commit 5b331b9

Please sign in to comment.