diff --git a/src/lib/src/private/easysslutils.h b/src/lib/src/private/easysslutils.h index aea9adc..632a275 100644 --- a/src/lib/src/private/easysslutils.h +++ b/src/lib/src/private/easysslutils.h @@ -11,59 +11,59 @@ namespace EasySSL { /** - * @brief The EasySSLUtils class This is base utils for work with opwnssl library. + * @brief The EasySSLUtils class These are basic utils for work with the opwnssl library. */ class EasySSLUtils { public: /** - * @brief printlastOpenSSlError This method print last ssl error message. + * @brief printlastOpenSSlError This method prints the latest ssl error message. */ static void printlastOpenSSlError(); /** - * @brief bignumToArray This method convert openssl BIGNUM into byteArray - * @param num This is big num of the openssl library + * @brief bignumToArray This method converts openssl BIGNUM into byteArray + * @param num This is a big num of the openssl library * @return bytes array. */ static QByteArray bignumToArray(const BIGNUM* num); /** - * @brief bignumFromArray This method convert Qt bytes array into opensll big num. - * @param array This is input array. + * @brief bignumFromArray This method converts the Qt bytes array into the opensll big num. + * @param array This is an input array. * @return big num pointer. - * @note This result pointer will not free automatically. Please free returned pointer after using. + * @note This result pointer will not be free automatically. Please free the returned pointer after use. */ - [[nodiscard("This pointer will not free automatically. Please free returned pointer after using.")]] + [[nodiscard("The result pointer will not be free automatically. Please free the returned pointer after using.")]] static BIGNUM* bignumFromArray(const QByteArray& array); /** - * @brief bioToByteArray This method conver openssl BIO to QByteArry + * @brief bioToByteArray This method converts the openssl BIO to the QByteArry * @param bio input arrary. * @return Qt Array */ static QByteArray bioToByteArray(BIO *bio); /** - * @brief byteArrayToBio This method create BIO struct from the Qt QByteArray object. - * @param byteArray This is input Qt byte array. - * @return pointer tot the BIO. - * @note Do not forget free result pointer. + * @brief byteArrayToBio This method creates the BIO struct from the Qt QByteArray object. + * @param byteArray This is an input Qt byte array. + * @return pointer to the BIO struct of OpenSLL library. + * @note Don't forget to free the result pointer. */ [[nodiscard("This pointer will not free automatically. Please free returned pointer after using.")]] static BIO *byteArrayToBio(const QByteArray &byteArray); /** - * @brief extractPublcKey This method extracts publick key from the ssl (pem) structure. - * @param ssl_keys This is ssl keys objects. + * @brief extractPublcKey This method extracts the public key from the ssl (pem) structure. + * @param ssl_keys These are objects of the ssl keys. * @return bytes array of the extracted key. */ static QByteArray extractPublcKey(EVP_PKEY* ssl_keys); /** - * @brief extractPrivateKey This method extracts private key from the ssl (pem) structure. - * @param ssl_keys This is ssl keys objects. + * @brief extractPrivateKey This method extracts the private key from the ssl (pem) structure. + * @param ssl_keys These are objects of the ssl keys. * @return bytes array of the extracted key. */ static QByteArray extractPrivateKey(EVP_PKEY* ssl_keys); diff --git a/src/lib/src/public/easyssl/ecdsassl.h b/src/lib/src/public/easyssl/ecdsassl.h index ec96909..edf4a30 100644 --- a/src/lib/src/public/easyssl/ecdsassl.h +++ b/src/lib/src/public/easyssl/ecdsassl.h @@ -56,7 +56,7 @@ public: QByteArray encrypt(const QByteArray &message, const QByteArray &key) override; /** - * @brief curve This method return current curve method. using only for generate new pair keys. + * @brief curve This method returns the current curve method. Using only for generating new pair of keys. * @return current cursve type. * @see EllipticCurveStandart */