Various fixes to doxygen API generation

* Fixed incorrect file definitions
 * Corrected function naming in X.509 module definition
This commit is contained in:
Simon Butcher
2016-01-03 16:14:14 +00:00
parent 6189175900
commit a02fe7c2cc
14 changed files with 32 additions and 30 deletions

View File

@@ -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
*

View File

@@ -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
*
@@ -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

View File

@@ -1,5 +1,5 @@
/**
* \file mbedtls_md.h
* \file md.h
*
* \brief Generic message digest wrapper
*

View File

@@ -1,5 +1,5 @@
/**
* \file mbedtls_md2.h
* \file md2.h
*
* \brief MD2 message digest algorithm (hash function)
*

View File

@@ -1,5 +1,5 @@
/**
* \file mbedtls_md4.h
* \file md4.h
*
* \brief MD4 message digest algorithm (hash function)
*

View File

@@ -1,5 +1,5 @@
/**
* \file mbedtls_md5.h
* \file md5.h
*
* \brief MD5 message digest algorithm (hash function)
*

View File

@@ -1,5 +1,5 @@
/**
* \file mbedtls_ripemd160.h
* \file ripemd160.h
*
* \brief RIPE MD-160 message digest
*

View File

@@ -1,5 +1,5 @@
/**
* \file mbedtls_sha1.h
* \file sha1.h
*
* \brief SHA-1 cryptographic hash function
*

View File

@@ -1,5 +1,5 @@
/**
* \file mbedtls_sha256.h
* \file sha256.h
*
* \brief SHA-224 and SHA-256 cryptographic hash function
*

View File

@@ -1,5 +1,5 @@
/**
* \file mbedtls_sha512.h
* \file sha512.h
*
* \brief SHA-384 and SHA-512 cryptographic hash function
*

View File

@@ -1,5 +1,5 @@
/**
* \file mbedtls_x509_crl.h
* \file x509_crl.h
*
* \brief X.509 certificate revocation list parsing
*
@@ -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
*/

View File

@@ -1,5 +1,5 @@
/**
* \file mbedtls_x509_crt.h
* \file x509_crt.h
*
* \brief X.509 certificate parsing and writing
*

View File

@@ -1,5 +1,5 @@
/**
* \file mbedtls_x509_csr.h
* \file x509_csr.h
*
* \brief X.509 certificate signing request parsing and writing
*