Switch to readthedocs.org for hosting documentation

Add API reference.
This commit is contained in:
Dmitri Tikhonov 2020-02-20 16:56:57 -05:00
parent b86524a470
commit 0bd320303d
114 changed files with 2142 additions and 11694 deletions

View file

@ -184,7 +184,7 @@ struct lsquic_stream_if {
*/
void (*on_hsk_done)(lsquic_conn_t *c, enum lsquic_hsk_status s);
/**
* When server sends a token in NEW_TOKEN frame, this callback is called.
* When client receives a token in NEW_TOKEN frame, this callback is called.
* The callback is optional.
*/
void (*on_new_token)(lsquic_conn_t *c, const unsigned char *token,
@ -1082,7 +1082,7 @@ lsquic_engine_has_unsent_packets (lsquic_engine_t *engine);
* Send out as many unsent packets as possibe: until we are out of unsent
* packets or until @ref ea_packets_out() fails.
*
* If @ref ea_packets_out() does fail (that is, it returns an error), this
* If @ref ea_packets_out() does fail cannot send all packets, this
* function must be called to signify that sending of packets is possible
* again.
*/
@ -1341,9 +1341,6 @@ int lsquic_stream_close(lsquic_stream_t *s);
* Get certificate chain returned by the server. This can be used for
* server certificate verification.
*
* If server certificate cannot be verified, the connection can be closed
* using lsquic_conn_cert_verification_failed().
*
* The caller releases the stack using sk_X509_free().
*/
struct stack_st_X509 *