Fix POD errors to stop make install_docs dying with pod2man 2.5.0+
[openssl.git] / doc / crypto / RSA_get_ex_new_index.pod
index 30900d92584a819c22e7d94df080b2a7ca37f254..7d0fd1f91de9ddb6fa9410b2f2712976c74fe933 100644 (file)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data - add application specific data to RSA structures.
+RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data - add application specific data to RSA structures
 
 =head1 SYNOPSIS
 
@@ -13,19 +13,16 @@ RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data - add application specifi
                CRYPTO_EX_dup *dup_func,
                CRYPTO_EX_free *free_func);
 
- int RSA_set_ex_data(RSA *r,int idx,void *arg);
+ int RSA_set_ex_data(RSA *r, int idx, void *arg);
 
  void *RSA_get_ex_data(RSA *r, int idx);
 
- int new_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
-                                       int idx, long argl, void *argp);
-
- void free_func(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
-                                       int idx, long argl, void *argp);
- int dup_func(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d, 
-                                       int idx, long argl, void *argp);
-
-
+ typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
+                           int idx, long argl, void *argp);
+ typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
+                             int idx, long argl, void *argp);
+ typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d,
+                           int idx, long argl, void *argp);
 
 =head1 DESCRIPTION
 
@@ -42,7 +39,7 @@ new application specific data. It takes three optional function pointers which
 are called when the parent structure (in this case an RSA structure) is
 initially created, when it is copied and when it is freed up. If any or all of
 these function pointer arguments are not used they should be set to NULL. The
-precise manner in which these function pointer are called is described in more
+precise manner in which these function pointers are called is described in more
 detail below. B<RSA_get_ex_new_index()> also takes additional long and pointer
 parameters which will be passed to the supplied functions but which otherwise
 have no special meaning. It returns an B<index> which should be stored
@@ -72,7 +69,7 @@ B<new_func()> and B<free_func()> take the same parameters. B<parent> is a
 pointer to the parent RSA structure. B<ptr> is a the application specific data
 (this wont be of much use in B<new_func()>. B<ad> is a pointer to the
 B<CRYPTO_EX_DATA> structure from the parent RSA structure: the functions
-B<CRYPTO_get_ex_data()> and B<CRYPTO_get_ex_data()> can be called to manipulate
+B<CRYPTO_get_ex_data()> and B<CRYPTO_set_ex_data()> can be called to manipulate
 it. The B<idx> parameter is the index: this will be the same value returned by
 B<RSA_get_ex_new_index()> when the functions were initially registered. Finally
 the B<argl> and B<argp> parameters are the values originally passed to the same
@@ -113,10 +110,11 @@ present in the parent RSA structure when it is called.
 
 =head1 SEE ALSO
 
-...
+L<rsa(3)|rsa(3)>, L<CRYPTO_set_ex_data(3)|CRYPTO_set_ex_data(3)>
 
 =head1 HISTORY
 
-...
+RSA_get_ex_new_index(), RSA_set_ex_data() and RSA_get_ex_data() are
+available since SSLeay 0.9.0.
 
 =cut