Create list of functions and methods to be documented

This commit is contained in:
Bart van Strien 2015-06-04 13:01:32 +02:00
parent 7ca7890368
commit 54db93c530
5 changed files with 83 additions and 0 deletions

19
doc/cert.md Normal file
View File

@ -0,0 +1,19 @@
Functions
---------
`cert.load`
Methods
-------
`cert:digest`
`cert:setencode`
`cert:extensions`
`cert:issuer`
`cert:notbefore`
`cert:notafter`
`cert:pem`
`cert:pubkey`
`cert:serial`
`cert:subject`
`cert:validat`

20
doc/context.md Normal file
View File

@ -0,0 +1,20 @@
Functions
---------
`context.create`
`context.locations`
`context.loadcert`
`context.loadkey`
`context.checkkey`
`context.setcipher`
`context.setdepth`
`context.setdhparam`
`context.setcurve`
`context.setverify`
`context.setoptions`
`context.setmode`
Methods
-------
`context:setverifyext`

9
doc/core.md Normal file
View File

@ -0,0 +1,9 @@
Functions
---------
`ssl.compression`
`ssl.create`
`ssl.info`
`ssl.setfd`
`ssl.setmethod`
`ssl.copyright`

13
doc/luasec.md Normal file
View File

@ -0,0 +1,13 @@
LuaSec
======
LuaSec is a binding for OpenSSL library to provide TLS/SSL communication. It
takes an already established TCP connection and creates a secure session
between the peers.
Functions
---------
`ssl.loadcertificate`
`ssl.newcontext`
`ssl.wrap`

22
doc/ssl.md Normal file
View File

@ -0,0 +1,22 @@
Created using `ssl.create` or `ssl.wrap`.
Methods
----------------------
`conn:close`
`conn:getfd`
`conn:getfinished`
`conn:getpeercertificate`
`conn:getpeerchain`
`conn:getpeerverification`
`conn:getpeerfinished`
`conn:getsniname`
`conn:getstats`
`conn:setstats`
`conn:dirty`
`conn:dohandshake`
`conn:receive`
`conn:send`
`conn:settimeout`
`conn:sni`
`conn:want`