Add a number of documentation files, mostly for SSL routines, but also

[openssl.git] / doc / crypto / DH_set_method.pod

diff --git a/doc/crypto/DH_set_method.pod b/doc/crypto/DH_set_method.pod
index b50bf42a56b3212aa39c492edc6f54fa6a6992f8..b9a61d542bd3acc6281fe0adad438ca783796318 100644 (file)
--- a/doc/crypto/DH_set_method.pod
+++ b/doc/crypto/DH_set_method.pod
@@ -3,7 +3,7 @@
 =head1 NAME
 
 DH_set_default_method, DH_get_default_method, DH_set_method,
-DH_new_method, DH_OpenSSL - Select RSA method
+DH_new_method, DH_OpenSSL - select DH method
 
 =head1 SYNOPSIS
 
@@ -36,9 +36,6 @@ method.
 
 DH_set_method() selects B<meth> for all operations using the structure B<dh>.
 
-DH_get_method() returns a pointer to the method currently selected
-for B<dh>.
-
 DH_new_method() allocates and initializes a B<DH> structure so that
 B<method> will be used for the DH operations. If B<method> is B<NULL>,
 the default method is used.
@@ -56,7 +53,7 @@ the default method is used.
      /* compute shared secret */
         int (*compute_key)(unsigned char *key, BIGNUM *pub_key, DH *dh);
 
-     /* compute r = a ^ p mod m. May be NULL */
+     /* compute r = a ^ p mod m (May be NULL for some implementations) */
         int (*bn_mod_exp)(DH *dh, BIGNUM *r, BIGNUM *a, const BIGNUM *p,
                                 const BIGNUM *m, BN_CTX *ctx,
                                 BN_MONT_CTX *m_ctx);
@@ -75,8 +72,8 @@ the default method is used.
 
 =head1 RETURN VALUES
 
-DH_OpenSSL(), DH_get_default_method() and DH_get_method() return
-pointers to the respective B<DH_METHOD>s.
+DH_OpenSSL() and DH_get_default_method() return pointers to the respective
+B<DH_METHOD>s.
 
 DH_set_default_method() returns no value.
 
@@ -84,12 +81,12 @@ DH_set_method() returns a pointer to the B<DH_METHOD> previously
 associated with B<dh>.
 
 DH_new_method() returns B<NULL> and sets an error code that can be
-obtained by ERR_get_error(3) if the allocation fails. Otherwise it
+obtained by L<ERR_get_error(3)|ERR_get_error(3)> if the allocation fails. Otherwise it
 returns a pointer to the newly allocated structure.
 
 =head1 SEE ALSO
 
-dh(3), DH_new(3)
+L<dh(3)|dh(3)>, L<DH_new(3)|DH_new(3)>
 
 =head1 HISTORY