Commit 71432849 authored by Manuel Pégourié-Gonnard's avatar Manuel Pégourié-Gonnard
Browse files

Use proper doxygen markup to mark deprecations

parent 47e0214d
......@@ -376,7 +376,7 @@ int cipher_init_ctx( cipher_context_t *ctx, const cipher_info_t *cipher_info );
* \brief Free the cipher-specific context of ctx. Freeing ctx
* itself remains the responsibility of the caller.
*
* \note Deprecated: Redirects to cipher_free()
* \deprecated Use cipher_free() instead
*
* \param ctx Free the cipher-specific context
*
......
......@@ -1695,7 +1695,9 @@
/**
* \def POLARSSL_MEMORY_C
* Deprecated since 1.3.5. Please use POLARSSL_PLATFORM_MEMORY instead.
*
* \deprecated Use POLARSSL_PLATFORM_MEMORY instead.
*
* Depends on: POLARSSL_PLATFORM_C
*/
//#define POLARSSL_MEMORY_C
......@@ -1768,7 +1770,8 @@
* \def POLARSSL_PBKDF2_C
*
* Enable PKCS#5 PBKDF2 key derivation function.
* DEPRECATED: Use POLARSSL_PKCS5_C instead
*
* \deprecated Use POLARSSL_PKCS5_C instead
*
* Module: library/pbkdf2.c
*
......
......@@ -204,7 +204,7 @@ int md_init_ctx( md_context_t *ctx, const md_info_t *md_info );
* \brief Free the message-specific context of ctx. Freeing ctx itself
* remains the responsibility of the caller.
*
* \note Deprecated: Redirects to md_free()
* \deprecated Use md_free() instead
*
* \param ctx Free the message-specific context
*
......
/**
* \file memory.h
*
* \brief Memory allocation layer (Deprecated to platform layer)
* \brief Memory allocation layer
*
* \deprecated Use the platform layer instead
*
* Copyright (C) 2006-2014, ARM Limited, All Rights Reserved
*
......@@ -35,6 +37,11 @@
#include "platform.h"
#include "memory_buffer_alloc.h"
/**
* \brief Set malloc() / free() callback
*
* \deprecated Use platform_set_malloc_free instead
*/
int memory_set_own( void * (*malloc_func)( size_t ),
void (*free_func)( void * ) )
{
......
......@@ -2,7 +2,8 @@
* \file pbkdf2.h
*
* \brief Password-Based Key Derivation Function 2 (from PKCS#5)
* DEPRECATED: use pkcs5.h instead.
*
* \deprecated Use pkcs5.h instead.
*
* \author Mathias Olsson <mathias@kompetensum.com>
*
......@@ -46,7 +47,8 @@ extern "C" {
/**
* \brief PKCS#5 PBKDF2 using HMAC
* DEPRECATED: Use pkcs5_pbkdf2_hmac() instead!
*
* \deprecated Use pkcs5_pbkdf2_hmac() instead
*
* \param ctx Generic HMAC context
* \param password Password to use when generating key
......@@ -66,7 +68,8 @@ int pbkdf2_hmac( md_context_t *ctx, const unsigned char *password,
/**
* \brief Checkup routine
* DEPRECATED: Use pkcs5_self_test() instead!
*
* \deprecated Use pkcs5_self_test() instead
*
* \return 0 if successful, or 1 if the test failed
*/
......
......@@ -30,7 +30,7 @@
#include POLARSSL_CONFIG_FILE
#endif
/* Temporary compability hack for to keep the deprecated MEMORY_C working */
/* Temporary compability hack for to keep MEMORY_C working */
#if defined(POLARSSL_MEMORY_C) && !defined(POLARSSL_PLATFORM_MEMORY)
#define POLARSSL_PLATFORM_MEMORY
#endif
......
......@@ -1221,8 +1221,7 @@ int ssl_set_own_cert( ssl_context *ssl, x509_crt *own_cert,
* up your certificate chain. The top certificate (self-signed)
* can be omitted.
*
* \warning This backwards-compatibility function is deprecated!
* Please use \c ssl_set_own_cert() instead.
* \deprecated Please use \c ssl_set_own_cert() instead.
*
* \param ssl SSL context
* \param own_cert own public certificate chain
......@@ -1246,8 +1245,7 @@ int ssl_set_own_cert_rsa( ssl_context *ssl, x509_crt *own_cert,
* up your certificate chain. The top certificate (self-signed)
* can be omitted.
*
* \warning This backwards-compatibility function is deprecated!
* Please use \c pk_init_ctx_rsa_alt()
* \deprecated Please use \c pk_init_ctx_rsa_alt()
* and \c ssl_set_own_cert() instead.
*
* \param ssl SSL context
......
......@@ -227,8 +227,10 @@ int x509_serial_gets( char *buf, size_t size, const x509_buf *serial );
/**
* \brief Give an known OID, return its descriptive string.
* (Deprecated. Use oid_get_extended_key_usage() instead.)
* Warning: only works for extended_key_usage OIDs!
*
* \deprecated Use oid_get_extended_key_usage() instead.
*
* \warning Only works for extended_key_usage OIDs!
*
* \param oid buffer containing the oid
*
......@@ -239,7 +241,8 @@ const char *x509_oid_get_description( x509_buf *oid );
/**
* \brief Give an OID, return a string version of its OID number.
* (Deprecated. Use oid_get_numeric_string() instead)
*
* \deprecated Use oid_get_numeric_string() instead.
*
* \param buf Buffer to write to
* \param size Maximum size of buffer
......
......@@ -165,7 +165,7 @@ int cipher_init_ctx( cipher_context_t *ctx, const cipher_info_t *cipher_info )
return( 0 );
}
/* Deprecated, redirects to cipher_free() */
/* compatibility wrapper */
int cipher_free_ctx( cipher_context_t *ctx )
{
cipher_free( ctx );
......
/**
* \file pbkdf2.c
*
* \brief Password-Based Key Derivation Function 2 (from PKCS#5)
* DEPRECATED: Use pkcs5.c instead
* \brief Compatibility wrappers for pkcs5.c
*
* \author Mathias Olsson <mathias@kompetensum.com>
*
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment