mirror of
				https://github.com/cuberite/polarssl.git
				synced 2025-11-03 20:22:59 -05:00 
			
		
		
		
	Misc documentation fixes/improvements
This commit is contained in:
		
							parent
							
								
									7037e222ea
								
							
						
					
					
						commit
						eaf55beead
					
				@ -40,6 +40,10 @@ typedef enum
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 * \brief           ECDH context structure
 | 
					 * \brief           ECDH context structure
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * \warning         Performing multiple operations concurrently on the same
 | 
				
			||||||
 | 
					 *                  ECDSA context is not supported; objects of this type
 | 
				
			||||||
 | 
					 *                  should not be shared between multiple threads.
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
typedef struct
 | 
					typedef struct
 | 
				
			||||||
{
 | 
					{
 | 
				
			||||||
@ -159,7 +163,7 @@ int mbedtls_ecdh_read_params( mbedtls_ecdh_context *ctx,
 | 
				
			|||||||
 *                  ServerKeyEchange for static ECDH: import ECDH parameters
 | 
					 *                  ServerKeyEchange for static ECDH: import ECDH parameters
 | 
				
			||||||
 *                  from a certificate's EC key information.)
 | 
					 *                  from a certificate's EC key information.)
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * \param ctx       ECDH constext to set
 | 
					 * \param ctx       ECDH context to set
 | 
				
			||||||
 * \param key       EC key to use
 | 
					 * \param key       EC key to use
 | 
				
			||||||
 * \param side      Is it our key (1) or the peer's key (0) ?
 | 
					 * \param side      Is it our key (1) or the peer's key (0) ?
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 | 
				
			|||||||
@ -52,6 +52,10 @@ extern "C" {
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 * \brief           ECDSA context structure
 | 
					 * \brief           ECDSA context structure
 | 
				
			||||||
 | 
					 *
 | 
				
			||||||
 | 
					 * \warning         Performing multiple operations concurrently on the same
 | 
				
			||||||
 | 
					 *                  ECDSA context is not supported; objects of this type
 | 
				
			||||||
 | 
					 *                  should not be shared between multiple threads.
 | 
				
			||||||
 */
 | 
					 */
 | 
				
			||||||
typedef mbedtls_ecp_keypair mbedtls_ecdsa_context;
 | 
					typedef mbedtls_ecp_keypair mbedtls_ecdsa_context;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -425,7 +425,7 @@ int mbedtls_x509_crt_verify_with_profile( mbedtls_x509_crt *crt,
 | 
				
			|||||||
 * \param flags    result of the verification
 | 
					 * \param flags    result of the verification
 | 
				
			||||||
 * \param f_vrfy   verification function
 | 
					 * \param f_vrfy   verification function
 | 
				
			||||||
 * \param p_vrfy   verification parameter
 | 
					 * \param p_vrfy   verification parameter
 | 
				
			||||||
 * \param rs_ctx   resart context
 | 
					 * \param rs_ctx   restart context
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * \return         See \c mbedtls_crt_verify_with_profile(), or
 | 
					 * \return         See \c mbedtls_crt_verify_with_profile(), or
 | 
				
			||||||
 *                 MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
 | 
					 *                 MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user