search

JuliaLang / MbedTLS.jl

Wrapper around mbedtls
Other
41 stars 50 forks source link

Improve docstrings #230

Closed cmcaine closed 3 years ago

cmcaine commented 3 years ago

614471b (Colin Caine, 19 seconds ago) Document SSLConfig methods

99dcf55 (Colin Caine, 34 seconds ago) Give signature in docs for Base. methods

cmcaine commented 3 years ago

Otherwise using MbedTLS pollutes Base's docstrings:

help?> close
search: close CIPHER_BLOWFISH

  close(stream)

  Close an I/O stream. Performs a flush first.

  ──────────────────────────────────────────────

  close(c::Channel[, excp::Exception])

  Close a channel. An exception (optionally given by excp), is thrown by:

    •  put! on a closed channel.

    •  take! and fetch on an empty, closed channel.

  ──────────────────────────────────────────────

  Send a TLS close_notify message to the peer.