Commit 121677b4 authored by Rich Salz's avatar Rich Salz
Browse files

Doc nits: callback function typedefs 



Enhance find-doc-nits to be better about finding typedefs for
callback functions.  Fix all nits it now finds.  Added some new
typedef names to ssl.h some of which were documented but did not
exist

Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2151)
parent 9c4319bd

doc/man3/BIO_ctrl.pod

+2 −1
Original line number Diff line number Diff line
@@ -5,7 +5,8 @@ 
BIO_ctrl, BIO_callback_ctrl, BIO_ptr_ctrl, BIO_int_ctrl, BIO_reset,

BIO_seek, BIO_tell, BIO_flush, BIO_eof, BIO_set_close, BIO_get_close,

BIO_pending, BIO_wpending, BIO_ctrl_pending, BIO_ctrl_wpending,

BIO_get_info_callback, BIO_set_info_callback - BIO control operations

BIO_get_info_callback, BIO_set_info_callback, bio_info_cb

- BIO control operations



=head1 SYNOPSIS

doc/man3/BIO_set_callback.pod

+2 −1
Original line number Diff line number Diff line
@@ -3,7 +3,8 @@ 
=head1 NAME



BIO_set_callback_ex, BIO_get_callback_ex, BIO_set_callback, BIO_get_callback,

BIO_set_callback_arg, BIO_get_callback_arg, BIO_debug_callback

BIO_set_callback_arg, BIO_get_callback_arg, BIO_debug_callback,

BIO_callback_fn_ex, BIO_callback_fn

- BIO callback functions



=head1 SYNOPSIS

doc/man3/EVP_PKEY_keygen.pod

+4 −2
Original line number Diff line number Diff line
@@ -5,7 +5,9 @@ 
EVP_PKEY_keygen_init, EVP_PKEY_keygen, EVP_PKEY_paramgen_init,

EVP_PKEY_paramgen, EVP_PKEY_CTX_set_cb, EVP_PKEY_CTX_get_cb,

EVP_PKEY_CTX_get_keygen_info, EVP_PKEY_CTX_set_app_data,

EVP_PKEY_CTX_get_app_data - key and parameter generation functions

EVP_PKEY_CTX_get_app_data,

EVP_PKEY_gen_cb

- key and parameter generation functions



=head1 SYNOPSIS
@@ -16,7 +18,7 @@ EVP_PKEY_CTX_get_app_data - key and parameter generation functions 
 int EVP_PKEY_paramgen_init(EVP_PKEY_CTX *ctx);

 int EVP_PKEY_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY **ppkey);



 typedef int EVP_PKEY_gen_cb(EVP_PKEY_CTX *ctx);

 typedef int (*EVP_PKEY_gen_cb)(EVP_PKEY_CTX *ctx);



 void EVP_PKEY_CTX_set_cb(EVP_PKEY_CTX *ctx, EVP_PKEY_gen_cb *cb);

 EVP_PKEY_gen_cb *EVP_PKEY_CTX_get_cb(EVP_PKEY_CTX *ctx);

doc/man3/SSL_CTX_set_generate_session_id.pod

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


=head1 NAME



SSL_CTX_set_generate_session_id, SSL_set_generate_session_id, SSL_has_matching_session_id - manipulate generation of SSL session IDs (server only)

SSL_CTX_set_generate_session_id, SSL_set_generate_session_id,

SSL_has_matching_session_id, GEN_SESSION_CB

- manipulate generation of SSL session IDs (server only)



=head1 SYNOPSIS

doc/man3/SSL_CTX_set_verify.pod

+7 −6
Original line number Diff line number Diff line
@@ -2,20 +2,21 @@ 


=head1 NAME



SSL_CTX_set_verify, SSL_set_verify, SSL_CTX_set_verify_depth, SSL_set_verify_depth - set peer certificate verification parameters

SSL_CTX_set_verify, SSL_set_verify,

SSL_CTX_set_verify_depth, SSL_set_verify_depth,

verify_cb

- set peer certificate verification parameters



=head1 SYNOPSIS



 #include <openssl/ssl.h>



 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,

                         int (*verify_callback)(int, X509_STORE_CTX *));

 void SSL_set_verify(SSL *s, int mode,

                     int (*verify_callback)(int, X509_STORE_CTX *));

 void SSL_CTX_set_verify(SSL_CTX *ctx, int mode, verify_cb verify_callback);

 void SSL_set_verify(SSL *s, int mode, verify_cb verify_callback);

 void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);

 void SSL_set_verify_depth(SSL *s, int depth);



 int verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx);

 typedef int (*verify_cb)(int preverify_ok, X509_STORE_CTX *x509_ctx);



=head1 DESCRIPTION