|Subject:||Documentation for CTX_ related functions|
|Date:||Thu, 09 Feb 2012 17:16:39 +0100|
|To:||bug-Net-SSLeay [...] rt.cpan.org|
|From:||kmx <kmx [...] volny.cz>|
Hi, I have tried to add documentation to CTX_... related functions + made a bit or reorganization. See attached patch. As for CTX: 1/ some functions are totally unclear to me (I suspect they cannot work correctly - look for ??? in POD) 2/ I have done two little fixes to XS (IMHO obvious errors) 3/ I am NOT gonna add missing tests for CTX_* functions (I wanna focus on X509_* functions - separate RT) Providing that we (I) will probably add even more documentation, it might be worth considering to move documentation into a separate SSLeay.pod The new doc structure looks like this: =head1 NAME =head1 SYNOPSIS =head1 DESCRIPTION =head2 High level functions for accessing web servers =head3 Basic set of functions =head3 Alternate versions of high-level API =head3 Using client certificates =head3 Working through a web proxy =head3 HTTP (without S) API =head2 Certificate verification and Certificate Revocation Lists (CRLs) =head2 Using Net::SSLeay in multi-threaded applications =head3 Initialization =head3 Using callbacks =head3 Using openssl elements =head3 Using other perl modules based on Net::SSLeay =head3 Combining Net::SSLeay with other modules linked with openssl =head3 Threading with get_https and friends =head2 Convenience routines =head2 Initialization =head2 Error handling functions =head2 Sockets =head2 Callbacks =head2 Low level API =head3 Low level API: Version related functions =head3 Low level API: CTX_* related functions =head3 Low level API: RAND_* related functions =head3 Low level API: ASN1_TIME_* related functions =head3 Low level API: X509_* related functions =head3 Low level API: Digest related functions =head3 Low level API: RSA_* related functions =head3 Low level API: Digests related functions =head3 Low level API: BIO_* related functions =head3 Low level API: Other functions =head1 EXAMPLES =head1 LIMITATIONS =head1 KNOWN BUGS AND CAVEATS =head1 DIAGNOSTICS =head1 BUGS AND SUPPORT =head1 AUTHOR =head1 COPYRIGHT =head1 SEE ALSO -- kmx
Message body is not shown because sender requested not to inline it.