Commit 8162f6f5 authored by Rich Salz's avatar Rich Salz
Browse files

More API docs; small changes. 



Also fix typo noted on GitHub.
Suppport typedef and #define to find-doc-nits

Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
parent 53934822

doc/crypto/ASN1_INTEGER_get_int64.pod

+1 −0
Original line number Original line Diff line number Diff line
@@ -2,6 +2,7 @@ 




=head1 NAME

=head1 NAME





ASN1_INTEGER_get_uint64, ASN1_INTEGER_set_uint64,

ASN1_INTEGER_get_int64, ASN1_INTEGER_get, ASN1_INTEGER_set_int64, ASN1_INTEGER_set, BN_to_ASN1_INTEGER, ASN1_INTEGER_to_BN, ASN1_ENUMERATED_get_int64, ASN1_ENUMERATED_get, ASN1_ENUMERATED_set_int64, ASN1_ENUMERATED_set, BN_to_ASN1_ENUMERATED, ASN1_ENUMERATED_to_BN, - ASN.1 INTEGER and ENUMERATED utilities

ASN1_INTEGER_get_int64, ASN1_INTEGER_get, ASN1_INTEGER_set_int64, ASN1_INTEGER_set, BN_to_ASN1_INTEGER, ASN1_INTEGER_to_BN, ASN1_ENUMERATED_get_int64, ASN1_ENUMERATED_get, ASN1_ENUMERATED_set_int64, ASN1_ENUMERATED_set, BN_to_ASN1_ENUMERATED, ASN1_ENUMERATED_to_BN, - ASN.1 INTEGER and ENUMERATED utilities





=head1 SYNOPSIS

=head1 SYNOPSIS

doc/crypto/BIO_ADDRINFO.pod

+3 −6
Original line number Original line Diff line number Diff line
@@ -2,9 +2,10 @@ 




=head1 NAME

=head1 NAME





BIO_ADDRINFO, BIO_ADDRINFO_lookup, BIO_ADDRINFO_next, BIO_ADDRINFO_free,

BIO_ADDRINFO, BIO_ADDRINFO_next, BIO_ADDRINFO_free,

BIO_ADDRINFO_family, BIO_ADDRINFO_socktype, BIO_ADDRINFO_protocol,

BIO_ADDRINFO_family, BIO_ADDRINFO_socktype, BIO_ADDRINFO_protocol,

BIO_ADDRINFO_sockaddr, BIO_ADDRINFO_sockaddr_size, BIO_ADDRINFO_address

BIO_ADDRINFO_address,

BIO_lookup

- BIO_ADDRINFO type and routines

- BIO_ADDRINFO type and routines





=head1 SYNOPSIS

=head1 SYNOPSIS
@@ -77,10 +78,6 @@ will leave an error indication on the OpenSSL error stack in that case. 
All other functions described here return 0 or B<NULL> when the

All other functions described here return 0 or B<NULL> when the

information they should return isn't available.

information they should return isn't available.





=head1 SEE ALSO



L<BIO_lookup(3)>



=head1 COPYRIGHT

=head1 COPYRIGHT





Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.

Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.

doc/crypto/BIO_should_retry.pod

+1 −1
Original line number Original line Diff line number Diff line
@@ -2,7 +2,7 @@ 




=head1 NAME

=head1 NAME





BIO_should_retry, BIO_should_read, BIO_should_write,

BIO_should_read, BIO_should_write,

BIO_should_io_special, BIO_retry_type, BIO_should_retry,

BIO_should_io_special, BIO_retry_type, BIO_should_retry,

BIO_get_retry_BIO, BIO_get_retry_reason, BIO_set_retry_reason - BIO retry

BIO_get_retry_BIO, BIO_get_retry_reason, BIO_set_retry_reason - BIO retry

functions

functions

doc/crypto/EC_KEY_new.pod

+1 −1
Original line number Original line Diff line number Diff line
@@ -6,7 +6,7 @@ EC_KEY_new, EC_KEY_get_flags, EC_KEY_set_flags, EC_KEY_clear_flags, 
EC_KEY_new_by_curve_name, EC_KEY_free, EC_KEY_copy, EC_KEY_dup, EC_KEY_up_ref,

EC_KEY_new_by_curve_name, EC_KEY_free, EC_KEY_copy, EC_KEY_dup, EC_KEY_up_ref,

EC_KEY_get0_group, EC_KEY_set_group, EC_KEY_get0_private_key,

EC_KEY_get0_group, EC_KEY_set_group, EC_KEY_get0_private_key,

EC_KEY_set_private_key, EC_KEY_get0_public_key, EC_KEY_set_public_key,

EC_KEY_set_private_key, EC_KEY_get0_public_key, EC_KEY_set_public_key,

EC_KEY_get_enc_flags, EC_KEY_set_enc_flags, EC_KEY_get_conv_form,

EC_KEY_get_conv_form,

EC_KEY_set_conv_form, EC_KEY_set_asn1_flag, EC_KEY_precompute_mult,

EC_KEY_set_conv_form, EC_KEY_set_asn1_flag, EC_KEY_precompute_mult,

EC_KEY_generate_key, EC_KEY_check_key, EC_KEY_set_public_key_affine_coordinates,

EC_KEY_generate_key, EC_KEY_check_key, EC_KEY_set_public_key_affine_coordinates,

EC_KEY_oct2key, EC_KEY_key2buf, EC_KEY_oct2priv, EC_KEY_priv2oct,

EC_KEY_oct2key, EC_KEY_key2buf, EC_KEY_oct2priv, EC_KEY_priv2oct,

doc/crypto/EVP_PKEY_encrypt.pod

+1 −1
Original line number Original line Diff line number Diff line
@@ -43,7 +43,7 @@ indicates the operation is not supported by the public key algorithm. 




=head1 EXAMPLE

=head1 EXAMPLE





Encrypt data using OAEP (for RSA keys). See also L<pem(3)> or

Encrypt data using OAEP (for RSA keys). See also L<PEM_read_PUBKEY(3)> or

L<d2i_X509(3)> for means to load a public key. You may also simply

L<d2i_X509(3)> for means to load a public key. You may also simply

set 'eng = NULL;' to start with the default OpenSSL RSA implementation:

set 'eng = NULL;' to start with the default OpenSSL RSA implementation: