Commit 14f46560 authored by huangqinjin's avatar huangqinjin Committed by Rich Salz
Browse files

doc and comment fixes 



Reviewed-by: default avatarMatt Caswell <matt@openssl.org>
Reviewed-by: default avatarRich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/1233)
parent b88e95f3

doc/crypto/EC_GROUP_copy.pod

+2 −2
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ EC_GROUP_copy, EC_GROUP_dup, EC_GROUP_method_of, EC_GROUP_set_generator, EC_GROU 


 int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx);

 const BIGNUM *EC_GROUP_get0_order(const EC_GROUP *group);

 const BIGNUM *EC_GROUP_order_bits(const EC_GROUP *group);

 int EC_GROUP_order_bits(const EC_GROUP *group);

 int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, BN_CTX *ctx);

 const BIGNUM *EC_GROUP_get0_cofactor(const EC_GROUP *group);
@@ -91,7 +91,7 @@ point_conversion_form_t is an enum defined as follows: 
        /** the point is encoded as z||x, where the octet z specifies

         *   which solution of the quadratic equation y is  */

        POINT_CONVERSION_COMPRESSED = 2,

        /** the point is encoded as z||x||y, where z is the octet 0x02  */

        /** the point is encoded as z||x||y, where z is the octet 0x04  */

        POINT_CONVERSION_UNCOMPRESSED = 4,

        /** the point is encoded as z||x||y, where the octet z specifies

         *  which solution of the quadratic equation y is  */

doc/crypto/EC_POINT_new.pod

+1 −1
Original line number Diff line number Diff line
@@ -105,7 +105,7 @@ this co-ordinate system provides more efficient point multiplication 
operations.  A mapping exists between Jacobian projective co-ordinates and

affine co-ordinates. A Jacobian projective co-ordinate (x, y, z) can be written

as an affine co-ordinate as (x/(z^2), y/(z^3)). Conversion to Jacobian

projective to affine co-ordinates is simple. The co-ordinate (x, y) is mapped

projective from affine co-ordinates is simple. The co-ordinate (x, y) is mapped

to (x, y, 1). To set or get the projective co-ordinates use

EC_POINT_set_Jprojective_coordinates_GFp() and

EC_POINT_get_Jprojective_coordinates_GFp() respectively.

doc/crypto/EVP_EncryptInit.pod

+1 −1
Original line number Diff line number Diff line
@@ -221,7 +221,7 @@ B<EVP_MAX_IV_LENGTH> is the maximum IV length for all ciphers. 


EVP_CIPHER_block_size() and EVP_CIPHER_CTX_block_size() return the block

size of a cipher when passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX>

structure. The constant B<EVP_MAX_IV_LENGTH> is also the maximum block

structure. The constant B<EVP_MAX_BLOCK_LENGTH> is also the maximum block

length for all ciphers.



EVP_CIPHER_type() and EVP_CIPHER_CTX_type() return the type of the passed

include/openssl/ec.h

+5 −8
Original line number Diff line number Diff line
@@ -173,7 +173,7 @@ const EC_POINT *EC_GROUP_get0_generator(const EC_GROUP *group); 


/** Returns the montgomery data for order(Generator)

 *  \param  group  EC_GROUP object

 *  \return the currently used generator (possibly NULL).

 *  \return the currently used montgomery data (possibly NULL).

*/

BN_MONT_CTX *EC_GROUP_get_mont_data(const EC_GROUP *group);
@@ -189,14 +189,12 @@ int EC_GROUP_get_order(const EC_GROUP *group, BIGNUM *order, BN_CTX *ctx); 
 *  \param  group  EC_GROUP object

 *  \return the group order

 */



const BIGNUM *EC_GROUP_get0_order(const EC_GROUP *group);



/** Gets the number of bits of the order of an EC_GROUP

 *  \param  group  EC_GROUP object

 *  \return number of bits of group order.

 */



int EC_GROUP_order_bits(const EC_GROUP *group);



/** Gets the cofactor of a EC_GROUP
@@ -212,7 +210,6 @@ int EC_GROUP_get_cofactor(const EC_GROUP *group, BIGNUM *cofactor, 
 *  \param  group  EC_GROUP object

 *  \return the group cofactor

 */



const BIGNUM *EC_GROUP_get0_cofactor(const EC_GROUP *group);



/** Sets the name of a EC_GROUP object
@@ -307,7 +304,7 @@ int EC_GROUP_check_discriminant(const EC_GROUP *group, BN_CTX *ctx); 
 *  \param  a    first EC_GROUP object

 *  \param  b    second EC_GROUP object

 *  \param  ctx  BN_CTX object (optional)

 *  \return 0 if both groups are equal and 1 otherwise

 *  \return 0 if the groups are equal, 1 if not, or -1 on error

 */

int EC_GROUP_cmp(const EC_GROUP *a, const EC_GROUP *b, BN_CTX *ctx);
@@ -639,7 +636,7 @@ int EC_POINT_is_at_infinity(const EC_GROUP *group, const EC_POINT *p); 
 *  \param  group  underlying EC_GROUP object

 *  \param  point  EC_POINT object to check

 *  \param  ctx    BN_CTX object (optional)

 *  \return 1 if point if on the curve and 0 otherwise

 *  \return 1 if the point is on the curve, 0 if not, or -1 on error

 */

int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point,

                         BN_CTX *ctx);
@@ -649,7 +646,7 @@ int EC_POINT_is_on_curve(const EC_GROUP *group, const EC_POINT *point, 
 *  \param  a      first EC_POINT object

 *  \param  b      second EC_POINT object

 *  \param  ctx    BN_CTX object (optional)

 *  \return 0 if both points are equal and a value != 0 otherwise

 *  \return 1 if the points are not equal, 0 if they are, or -1 on error

 */

int EC_POINT_cmp(const EC_GROUP *group, const EC_POINT *a, const EC_POINT *b,

                 BN_CTX *ctx);
@@ -658,7 +655,7 @@ int EC_POINT_make_affine(const EC_GROUP *group, EC_POINT *point, BN_CTX *ctx); 
int EC_POINTs_make_affine(const EC_GROUP *group, size_t num,

                          EC_POINT *points[], BN_CTX *ctx);



/** Computes r = generator * n sum_{i=0}^{num-1} p[i] * m[i]

/** Computes r = generator * n + sum_{i=0}^{num-1} p[i] * m[i]

 *  \param  group  underlying EC_GROUP object

 *  \param  r      EC_POINT object for the result

 *  \param  n      BIGNUM with the multiplier for the group generator (optional)

doc/crypto/BN_bn2bin.pod

+1 −1

File changed.

Contains only whitespace changes.