From 089b70d5a69fa54446c9c5349b6fd11d0483ba52 Mon Sep 17 00:00:00 2001
From: Paul Bakker
Date: Wed, 7 Nov 2012 19:57:39 +0000
Subject: [PATCH] Fixed doxygen blocks (cherry picked from commit
77db6ce3481ad610ee786d5ab171d5d10c1cb59d)
---
include/polarssl/aes.h | 2 +-
include/polarssl/arc4.h | 2 +-
include/polarssl/bignum.h | 4 ++--
include/polarssl/camellia.h | 2 +-
include/polarssl/config.h | 2 +-
include/polarssl/des.h | 2 +-
include/polarssl/dhm.h | 2 +-
include/polarssl/x509.h | 2 +-
include/polarssl/xtea.h | 2 +-
9 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/include/polarssl/aes.h b/include/polarssl/aes.h
index 80fd6d932..b85f977b7 100644
--- a/include/polarssl/aes.h
+++ b/include/polarssl/aes.h
@@ -134,7 +134,7 @@ int aes_crypt_cfb128( aes_context *ctx,
const unsigned char *input,
unsigned char *output );
-/*
+/**
* \brief AES-CTR buffer encryption/decryption
*
* Warning: You have to keep the maximum use of your counter in mind!
diff --git a/include/polarssl/arc4.h b/include/polarssl/arc4.h
index 48ad60b26..7233384b2 100644
--- a/include/polarssl/arc4.h
+++ b/include/polarssl/arc4.h
@@ -66,7 +66,7 @@ void arc4_setup( arc4_context *ctx, const unsigned char *key, unsigned int keyle
int arc4_crypt( arc4_context *ctx, size_t length, const unsigned char *input,
unsigned char *output );
-/*
+/**
* \brief Checkup routine
*
* \return 0 if successful, or 1 if the test failed
diff --git a/include/polarssl/bignum.h b/include/polarssl/bignum.h
index aed779db3..474324afa 100644
--- a/include/polarssl/bignum.h
+++ b/include/polarssl/bignum.h
@@ -184,7 +184,7 @@ void mpi_swap( mpi *X, mpi *Y );
*/
int mpi_lset( mpi *X, t_sint z );
-/*
+/**
* \brief Get a specific bit from X
*
* \param X MPI to use
@@ -194,7 +194,7 @@ int mpi_lset( mpi *X, t_sint z );
*/
int mpi_get_bit( mpi *X, size_t pos );
-/*
+/**
* \brief Set a bit of X to a specific value of 0 or 1
*
* \note Will grow X if necessary to set a bit to 1 in a not yet
diff --git a/include/polarssl/camellia.h b/include/polarssl/camellia.h
index b2b12945f..f073d469a 100644
--- a/include/polarssl/camellia.h
+++ b/include/polarssl/camellia.h
@@ -139,7 +139,7 @@ int camellia_crypt_cfb128( camellia_context *ctx,
const unsigned char *input,
unsigned char *output );
-/*
+/**
* \brief CAMELLIA-CTR buffer encryption/decryption
*
* Warning: You have to keep the maximum use of your counter in mind!
diff --git a/include/polarssl/config.h b/include/polarssl/config.h
index ea518d77d..6d4aca8e7 100644
--- a/include/polarssl/config.h
+++ b/include/polarssl/config.h
@@ -606,7 +606,7 @@
*/
#define POLARSSL_SSL_CLI_C
-/*
+/**
* \def POLARSSL_SSL_SRV_C
*
* Enable the SSL/TLS server code.
diff --git a/include/polarssl/des.h b/include/polarssl/des.h
index 653e68b38..a6be4711c 100644
--- a/include/polarssl/des.h
+++ b/include/polarssl/des.h
@@ -213,7 +213,7 @@ int des3_crypt_cbc( des3_context *ctx,
const unsigned char *input,
unsigned char *output );
-/*
+/**
* \brief Checkup routine
*
* \return 0 if successful, or 1 if the test failed
diff --git a/include/polarssl/dhm.h b/include/polarssl/dhm.h
index 0c8dd55ed..ee491c1d9 100644
--- a/include/polarssl/dhm.h
+++ b/include/polarssl/dhm.h
@@ -134,7 +134,7 @@ int dhm_make_public( dhm_context *ctx, int x_size,
int dhm_calc_secret( dhm_context *ctx,
unsigned char *output, size_t *olen );
-/*
+/**
* \brief Free the components of a DHM key
*/
void dhm_free( dhm_context *ctx );
diff --git a/include/polarssl/x509.h b/include/polarssl/x509.h
index cd0dc84a6..9b07a0921 100644
--- a/include/polarssl/x509.h
+++ b/include/polarssl/x509.h
@@ -617,7 +617,7 @@ int x509parse_crl_info( char *buf, size_t size, const char *prefix,
*/
const char *x509_oid_get_description( x509_buf *oid );
-/*
+/**
* \brief Give an OID, return a string version of its OID number.
*
* \param buf Buffer to write to
diff --git a/include/polarssl/xtea.h b/include/polarssl/xtea.h
index e2adb8788..0db7bc8eb 100644
--- a/include/polarssl/xtea.h
+++ b/include/polarssl/xtea.h
@@ -97,7 +97,7 @@ int xtea_crypt_cbc( xtea_context *ctx,
unsigned char *input,
unsigned char *output);
-/*
+/**
* \brief Checkup routine
*
* \return 0 if successful, or 1 if the test failed