Changed param's, examples and brief's

doc/dox_comments/header_files/ecc.h

@@ -154,13 +154,12 @@ int wc_ecc_check_key(ecc_key* key);
 
     \brief This function frees an ecc_key key after it has been used.
 
-    \return int integer returned indicating wolfSSL error or success status.
 
-    \param key pointer to the ecc_key object to free
+    \param key pointer to the ecc_key structure to free
 
     _Example_
     \code
-    // initialize key and perform secure exchanges
+    // initialize key and perform ECC operations
     ...
     wc_ecc_key_free(&key);
     \endcode
@@ -169,7 +168,7 @@ int wc_ecc_check_key(ecc_key* key);
     \sa wc_ecc_init_ex
 */
 WOLFSSL_API
-int wc_ecc_key_free(ecc_key* key);
+void wc_ecc_key_free(ecc_key* key);
 
 /*!
     \ingroup ECC
@@ -573,6 +572,8 @@ int wc_ecc_init(ecc_key* key);
     \return MEMORY_E Returned if there is an error allocating memory
 
     \param key pointer to the ecc_key object to initialize
+    \param devId ID to use with async hardware
+    \param heap pointer to a heap identifier
 
     _Example_
     \code

doc/dox_comments/header_files/random.h

@@ -140,14 +140,16 @@ WOLFSSL_API int  wc_RNG_GenerateBlock(WC_RNG*, byte*, word32 sz);
 /*!
     \ingroup Random
 
-    \brief Creates a new random number.
+    \brief Creates a new WC_RNG structure.
 
 
-    \return rng on success
+    \return WC_RNG structure on success
     \return NULL on error
 
 
-    \param rng random number generator initialized with wc_InitRng
+    \param heap pointer to a heap identifier
+    \param nonce pointer to the buffer containing the nonce
+    \param nonceSz length of the nonce
 
     _Example_
     \code

doc/dox_comments/header_files/ssl.h

@@ -2699,12 +2699,13 @@ WOLFSSL_API void wolfSSL_load_error_strings(void);
 WOLFSSL_API int  wolfSSL_library_init(void);
 
 /*!
-    \brief This function sets the Device Id.
+    \brief This function sets the Device Id at the WOLFSSL session level.
 
     \return WOLFSSL_SUCCESS upon success.
     \return BAD_FUNC_ARG if ssl is NULL.
 
     \param ssl pointer to a SSL object, created with wolfSSL_new().
+    \param devId ID to use with async hardware
 
     _Example_
     \code
@@ -2721,12 +2722,13 @@ WOLFSSL_API int  wolfSSL_library_init(void);
 WOLFSSL_API int wolfSSL_SetDevId(WOLFSSL* ssl, int devId)
 
 /*!
-    \brief This function sets the Device Id.
+    \brief This function sets the Device Id at the WOLFSSL_CTX context level.
 
     \return WOLFSSL_SUCCESS upon success.
     \return BAD_FUNC_ARG if ssl is NULL.
 
-    \param ssl pointer to a SSL object, created with wolfSSL_CTX_new().
+    \param ssl pointer to a SSL object, created with wolfSSL_new().
+    \param devId ID to use with async hardware
 
     _Example_
     \code
@@ -2748,7 +2750,8 @@ WOLFSSL_API int wolfSSL_CTX_SetDevId(WOLFSSL_CTX* ctx, int devId)
     \return devId upon success.
     \return INVALID_DEVID if both ssl and ctx are NULL.
 
-    \param ssl pointer to a SSL object, created with wolfSSL_CTX_new().
+    \param ctx pointer to the SSL context, created with wolfSSL_CTX_new().
+    \param ssl pointer to a SSL object, created with wolfSSL_new().
 
     _Example_
     \code
@@ -4490,14 +4493,14 @@ WOLFSSL_API int wolfSSL_X509_NAME_get_text_by_NID(
 WOLFSSL_API int wolfSSL_X509_get_signature_type(WOLFSSL_X509*);
 
 /*!
-    \brief This function frees an external WOLFSSL_X509 structure.
+    \brief This function frees a WOLFSSL_X509 structure.
 
 
     \param x509 a pointer to the WOLFSSL_X509 struct.
 
     _Example_
     \code
-    WOLFSSL_X509* x509 = (WOLFSSL_X509)XMALOC(sizeof(WOLFSSL_X509), NULL,
+    WOLFSSL_X509* x509 = (WOLFSSL_X509*)XMALOC(sizeof(WOLFSSL_X509), NULL,
     DYNAMIC_TYPE_X509) ;
 
     wolfSSL_X509_free(x509);
@@ -4632,20 +4635,21 @@ WOLFSSL_API int wolfSSL_X509_STORE_set_flags(WOLFSSL_X509_STORE* store,
 /*!
     \ingroup CertsKeys
 
-    \brief This function returns the value stored in the sigOID
+    \brief This function the certificate "not before" validity encoded as
-    member of the WOLFSSL_X509 structure.
+    a byte array.
+
 
     \return NULL returned if the WOLFSSL_X509 structure is NULL.
     \return byte is returned that contains the notBeforeData.
 
-    \param ssl a pointer to a WOLFSSL structure, created using wolfSSL_new().
+    \param x509 pointer to a WOLFSSL_X509 structure.
 
     _Example_
     \code
-    WOLFSSL_X509 x509 = (WOLFSSL_X509*)XMALLOC(sizeof(WOLFSSL_X509), NULL,
+    WOLFSSL_X509* x509 = (WOLFSSL_X509*)XMALLOC(sizeof(WOLFSSL_X509), NULL,
 							DYNAMIC_TYPE_X509);
     ...
-    byte notBeforeData = wolfSSL_X509_notBefore(x509);
+    byte* notBeforeData = wolfSSL_X509_notBefore(x509);
 
 
     \endcode
@@ -4662,20 +4666,20 @@ WOLFSSL_API const byte* wolfSSL_X509_notBefore(WOLFSSL_X509* x509);
 /*!
     \ingroup CertsKeys
 
-    \brief This function returns the value stored in the sigOID
+    \brief This function the certificate "not after" validity encoded as
-    member of the WOLFSSL_X509 structure.
+    a byte array.
 
     \return NULL returned if the WOLFSSL_X509 structure is NULL.
     \return byte is returned that contains the notAfterData.
 
-    \param ssl a pointer to a WOLFSSL structure, created using wolfSSL_new().
+    \param x509 pointer to a WOLFSSL_X509 structure.
 
     _Example_
     \code
-    WOLFSSL_X509 x509 = (WOLFSSL_X509*)XMALLOC(sizeof(WOLFSSL_X509), NULL,
+    WOLFSSL_X509* x509 = (WOLFSSL_X509*)XMALLOC(sizeof(WOLFSSL_X509), NULL,
 							DYNAMIC_TYPE_X509);
     ...
-    byte notAfterData = wolfSSL_X509_notAfter(x509);
+    byte* notAfterData = wolfSSL_X509_notAfter(x509);
 
 
     \endcode
@@ -7756,12 +7760,12 @@ WOLFSSL_API int   wolfSSL_DTLS_SetCookieSecret(WOLFSSL*,
                                                unsigned int);
 
 /*!
-    \brief This function retrieves the Device Id.
+    \brief This function retrieves the random number.
 
     \return rng upon success.
     \return NULL if ssl is NULL.
 
-    \param ssl pointer to a SSL object, created with wolfSSL_CTX_new().
+    \param ssl pointer to a SSL object, created with wolfSSL_new().
 
     _Example_
     \code