diff --git a/include/libwebsockets/lws-adopt.h b/include/libwebsockets/lws-adopt.h index 2d4fc5d60..8536e1d30 100644 --- a/include/libwebsockets/lws-adopt.h +++ b/include/libwebsockets/lws-adopt.h @@ -93,7 +93,7 @@ struct lws_udp { * lws_adopt_descriptor_vhost() - adopt foreign socket or file descriptor * if socket descriptor, should already have been accepted from listen socket * -* \param vhost: lws vhost +* \param vh: lws vhost * \param type: OR-ed combinations of lws_adoption_type flags * \param fd: union with either .sockfd or .filefd set * \param vh_prot_name: NULL or vh protocol name to bind raw connection to @@ -120,7 +120,7 @@ lws_adopt_descriptor_vhost(struct lws_vhost *vh, lws_adoption_type type, * \param accept_fd: fd of already-accepted socket to adopt * \param readbuf: NULL or pointer to data that must be drained before reading from * accept_fd - * \param len: The length of the data held at \param readbuf + * \param len: The length of the data held at \p readbuf * * Either returns new wsi bound to accept_fd, or closes accept_fd and * returns NULL, having cleaned up any new wsi pieces. @@ -131,10 +131,10 @@ lws_adopt_descriptor_vhost(struct lws_vhost *vh, lws_adoption_type type, * If your external code did not already read from the socket, you can use * lws_adopt_socket() instead. * - * This api is guaranteed to use the data at \param readbuf first, before reading from + * This api is guaranteed to use the data at \p readbuf first, before reading from * the socket. * - * readbuf is limited to the size of the ah rx buf, currently 2048 bytes. + * \p readbuf is limited to the size of the ah rx buf, currently 2048 bytes. */ LWS_VISIBLE LWS_EXTERN struct lws * lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd, @@ -144,9 +144,8 @@ lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd, * accepted it for vhost. * \param vhost: lws vhost * \param accept_fd: fd of already-accepted socket to adopt - * \param readbuf: NULL or pointer to data that must be drained before - * reading from accept_fd - * \param len: The length of the data held at \param readbuf + * \param readbuf: NULL or pointer to data that must be drained before reading from accept_fd + * \param len: The length of the data held at \p readbuf * * Either returns new wsi bound to accept_fd, or closes accept_fd and * returns NULL, having cleaned up any new wsi pieces. @@ -157,10 +156,10 @@ lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd, * If your external code did not already read from the socket, you can use * lws_adopt_socket() instead. * - * This api is guaranteed to use the data at \param readbuf first, before reading from + * This api is guaranteed to use the data at \p readbuf first, before reading from * the socket. * - * readbuf is limited to the size of the ah rx buf, currently 2048 bytes. + * \p readbuf is limited to the size of the ah rx buf, currently 2048 bytes. */ LWS_VISIBLE LWS_EXTERN struct lws * lws_adopt_socket_vhost_readbuf(struct lws_vhost *vhost, diff --git a/include/libwebsockets/lws-context-vhost.h b/include/libwebsockets/lws-context-vhost.h index 6f741d6ed..4c193813e 100644 --- a/include/libwebsockets/lws-context-vhost.h +++ b/include/libwebsockets/lws-context-vhost.h @@ -912,6 +912,7 @@ lws_get_vhost_name(struct lws_vhost *vhost); /** * lws_get_vhost_by_name() - returns the vhost with the requested name, or NULL * + * \param context: the lws_context to look in * \param name: vhost name we are looking for * * Returns NULL, or the vhost with the name \p name diff --git a/include/libwebsockets/lws-diskcache.h b/include/libwebsockets/lws-diskcache.h index 64ee9d99a..bec8082d6 100644 --- a/include/libwebsockets/lws-diskcache.h +++ b/include/libwebsockets/lws-diskcache.h @@ -184,3 +184,4 @@ lws_diskcache_trim(struct lws_diskcache_scan *lds); */ LWS_VISIBLE LWS_EXTERN int lws_diskcache_secs_to_idle(struct lws_diskcache_scan *lds); +///@} diff --git a/include/libwebsockets/lws-genaes.h b/include/libwebsockets/lws-genaes.h index 5d2f9a840..de5b5cdd0 100644 --- a/include/libwebsockets/lws-genaes.h +++ b/include/libwebsockets/lws-genaes.h @@ -130,7 +130,6 @@ lws_genaes_destroy(struct lws_genaes_ctx *ctx, unsigned char *tag, size_t tlen); * \param in: input plaintext or ciphertext * \param len: length of input (which is always length of output) * \param out: output plaintext or ciphertext - * \param op: LWS_GAESO_ENC or LWS_GAESO_DEC * \param iv_or_nonce_ctr_or_data_unit_16: NULL, iv, nonce_ctr16, or data_unit16 * \param stream_block_16: pointer to 16-byte stream block for CTR mode only * \param nc_or_iv_off: NULL or pointer to nc, or iv_off diff --git a/include/libwebsockets/lws-genhash.h b/include/libwebsockets/lws-genhash.h index 6ff1291a3..292a1ff62 100644 --- a/include/libwebsockets/lws-genhash.h +++ b/include/libwebsockets/lws-genhash.h @@ -22,7 +22,7 @@ * IN THE SOFTWARE. */ -/*! \defgroup generic hash +/*! \defgroup generichash Generic Hash * ## Generic Hash related functions * * Lws provides generic hash / digest accessors that abstract the ones diff --git a/include/libwebsockets/lws-genrsa.h b/include/libwebsockets/lws-genrsa.h index b18e2e421..744a4843b 100644 --- a/include/libwebsockets/lws-genrsa.h +++ b/include/libwebsockets/lws-genrsa.h @@ -22,7 +22,7 @@ * IN THE SOFTWARE. */ -/*! \defgroup generic RSA +/*! \defgroup genericRSA Generic RSA * ## Generic RSA related functions * * Lws provides generic RSA functions that abstract the ones diff --git a/include/libwebsockets/lws-jwk.h b/include/libwebsockets/lws-jwk.h index 2019d4bad..0c4bcac92 100644 --- a/include/libwebsockets/lws-jwk.h +++ b/include/libwebsockets/lws-jwk.h @@ -133,6 +133,8 @@ lws_jwk_export(struct lws_jwk *jwk, int _private, char *p, int *len); * * \param jwk: the JWK object to load into * \param filename: filename to load from + * \param cb: optional callback for each key + * \param user: opaque user pointer passed to cb if given * * Returns 0 for OK or -1 for failure * diff --git a/include/libwebsockets/lws-jws.h b/include/libwebsockets/lws-jws.h index ab17560ec..1e1fb8b2f 100644 --- a/include/libwebsockets/lws-jws.h +++ b/include/libwebsockets/lws-jws.h @@ -79,6 +79,8 @@ struct lws_jws { * lws_jws_init() - initialize a jws for use * * \param jws: pointer to the jws to initialize + * \param jwk: the jwk to use with this jws + * \param context: the lws_context to use */ LWS_VISIBLE LWS_EXTERN void lws_jws_init(struct lws_jws *jws, struct lws_jwk *jwk, @@ -101,7 +103,9 @@ lws_jws_destroy(struct lws_jws *jws); * * \param map: pointers and lengths for each of the unencoded JWS elements * \param jwk: public key - * \param content: lws_context + * \param context: lws_context + * \param temp: scratchpad + * \param temp_len: length of scratchpad * * Confirms the signature on a JWS. Use if you have non-b64 plain JWS elements * in a map... it'll make a temp b64 version needed for comparison. See below @@ -127,7 +131,9 @@ lws_jws_sig_confirm_compact_b64_map(struct lws_jws_map *map_b64, * \param len: bytes available at \p in * \param map: map to take decoded non-b64 content * \param jwk: public key - * \param content: lws_context + * \param context: lws_context + * \param temp: scratchpad + * \param temp_len: size of scratchpad * * Confirms the signature on a JWS. Use if you have you have b64 compact layout * (jose.payload.hdr.sig) as an aggregated string... it'll make a temp plain @@ -148,7 +154,7 @@ lws_jws_sig_confirm_compact_b64(const char *in, size_t len, * \param map_b64: pointers and lengths for each of the b64-encoded JWS elements * \param map: pointers and lengths for each of the unencoded JWS elements * \param jwk: public key - * \param content: lws_context + * \param context: lws_context * * Confirms the signature on a JWS. Use if you have you already have both b64 * compact layout (jose.payload.hdr.sig) and decoded JWS elements in maps. @@ -386,8 +392,8 @@ lws_jws_base64_enc(const char *in, size_t in_len, char *out, size_t out_max); * \param in: the incoming plaintext * \param in_len: the length of the incoming plaintext in bytes * \param first: nonzero if the first section - * \param out: the buffer to store the b64url encoded data to - * \param out_max: the length of \p out in bytes + * \param p: the buffer to store the b64url encoded data to + * \param end: just past the end of p * * Returns either -1 if problems, or the number of bytes written to \p out. * If the section is not the first one, '.' is prepended. diff --git a/include/libwebsockets/lws-lwsac.h b/include/libwebsockets/lws-lwsac.h index bcaa90d88..9e2af0e9b 100644 --- a/include/libwebsockets/lws-lwsac.h +++ b/include/libwebsockets/lws-lwsac.h @@ -22,7 +22,7 @@ * IN THE SOFTWARE. */ -/** \defgroup log lwsac +/** \defgroup lwsac lwsac * * ##Allocated Chunks * diff --git a/include/libwebsockets/lws-misc.h b/include/libwebsockets/lws-misc.h index d54687a37..2eefd0b2e 100644 --- a/include/libwebsockets/lws-misc.h +++ b/include/libwebsockets/lws-misc.h @@ -857,6 +857,7 @@ LWS_VISIBLE LWS_EXTERN int lws_is_ssl(struct lws *wsi); /** * lws_is_cgi() - find out if this wsi is running a cgi process + * * \param wsi: lws connection */ LWS_VISIBLE LWS_EXTERN int @@ -865,9 +866,8 @@ lws_is_cgi(struct lws *wsi); /** * lws_open() - platform-specific wrapper for open that prepares the fd * - * \param file: the filepath to open - * \param oflag: option flags - * \param mode: optional mode of any created file + * \param __file: the filepath to open + * \param __oflag: option flags * * This is a wrapper around platform open() that sets options on the fd * according to lws policy. Currently that is FD_CLOEXEC to stop the opened diff --git a/include/libwebsockets/lws-protocols-plugins.h b/include/libwebsockets/lws-protocols-plugins.h index 441ba598f..addf79f1a 100644 --- a/include/libwebsockets/lws-protocols-plugins.h +++ b/include/libwebsockets/lws-protocols-plugins.h @@ -182,7 +182,7 @@ lws_pvo_search(const struct lws_protocol_vhost_options *pvo, const char *name); /** * lws_pvo_get_str() - retreive a string pvo value * - * \param pvo: the first pvo in the linked-list + * \param in: the first pvo in the linked-list * \param name: the name of the pvo to return if found * \param result: pointer to a const char * to get the result if any * diff --git a/include/libwebsockets/lws-spa.h b/include/libwebsockets/lws-spa.h index fb1ae115a..c5ddab2c7 100644 --- a/include/libwebsockets/lws-spa.h +++ b/include/libwebsockets/lws-spa.h @@ -135,8 +135,8 @@ lws_spa_create_via_info(struct lws *wsi, const lws_spa_create_info_t *info); * lws_spa_process() - parses a chunk of input data * * \param spa: the parser object previously created - * \param in: incoming, urlencoded data - * \param len: count of bytes valid at \param in + * \param in: incoming urlencoded data + * \param len: count of bytes valid at \p in */ LWS_VISIBLE LWS_EXTERN int lws_spa_process(struct lws_spa *spa, const char *in, int len); diff --git a/include/libwebsockets/lws-ws-close.h b/include/libwebsockets/lws-ws-close.h index 29b1feb83..0d7b22b44 100644 --- a/include/libwebsockets/lws-ws-close.h +++ b/include/libwebsockets/lws-ws-close.h @@ -116,7 +116,7 @@ enum lws_close_status { * \param wsi: The websocket connection to set the close reason on * \param status: A valid close status from websocket standard * \param buf: NULL or buffer containing up to 124 bytes of auxiliary data - * \param len: Length of data in \param buf to send + * \param len: Length of data in \p buf to send */ LWS_VISIBLE LWS_EXTERN void lws_close_reason(struct lws *wsi, enum lws_close_status status, diff --git a/libwebsockets.dox b/libwebsockets.dox index 15bd4e845..692223652 100644 --- a/libwebsockets.dox +++ b/libwebsockets.dox @@ -103,17 +103,26 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- INPUT = include/libwebsockets.h \ include/libwebsockets/lws-adopt.h \ + include/libwebsockets/lws-async-dns.h \ include/libwebsockets/lws-callbacks.h \ include/libwebsockets/lws-cgi.h \ include/libwebsockets/lws-client.h \ include/libwebsockets/lws-context-vhost.h \ include/libwebsockets/lws-dbus.h \ + include/libwebsockets/lws-detailed-latency.h \ include/libwebsockets/lws-diskcache.h \ + include/libwebsockets/lws-dsh.h \ include/libwebsockets/lws-esp32.h \ + include/libwebsockets/lws-freertos.h \ include/libwebsockets/lws-fts.h \ + include/libwebsockets/lws-genaes.h \ + include/libwebsockets/lws-gencrypto.h \ + include/libwebsockets/lws-genec.h \ include/libwebsockets/lws-genhash.h \ include/libwebsockets/lws-genrsa.h \ include/libwebsockets/lws-http.h \ + include/libwebsockets/lws-jose.h \ + include/libwebsockets/lws-jwe.h \ include/libwebsockets/lws-jwk.h \ include/libwebsockets/lws-jws.h \ include/libwebsockets/lws-lejp.h \ @@ -124,11 +133,16 @@ INPUT = include/libwebsockets.h \ include/libwebsockets/lws-plugin-generic-sessions.h \ include/libwebsockets/lws-protocols-plugins.h \ include/libwebsockets/lws-purify.h \ + include/libwebsockets/lws-retry.h \ include/libwebsockets/lws-ring.h \ + include/libwebsockets/lws-sequencer.h \ include/libwebsockets/lws-service.h \ include/libwebsockets/lws-sha1-base64.h \ include/libwebsockets/lws-spa.h \ include/libwebsockets/lws-stats.h \ + include/libwebsockets/lws-struct.h \ + include/libwebsockets/lws-system.h \ + include/libwebsockets/lws-test-sequencer.h \ include/libwebsockets/lws-threadpool.h \ include/libwebsockets/lws-timeout-timer.h \ include/libwebsockets/lws-tokenize.h \ @@ -141,23 +155,32 @@ INPUT = include/libwebsockets.h \ include/libwebsockets/lws-x509.h \ plugins/ssh-base/include/lws-plugin-ssh.h \ ./READMEs/mainpage.md \ + ./READMEs/README.async-dns.md \ ./READMEs/README.build.md \ ./READMEs/README.ci.md \ + ./READMEs/README.coding.md \ ./READMEs/README.content-security-policy.md \ ./READMEs/README.contributing.md \ - ./READMEs/README.http-fallback.md \ - ./READMEs/README.release-policy.md \ - ./READMEs/README.unix-domain-reverse-proxy.md \ - ./READMEs/README.vulnerability-reporting.md \ - ./READMEs/README.problems.md \ - ./READMEs/README.lwsws.md \ - ./READMEs/README.coding.md \ + ./READMEs/README.crypto-apis.md \ + ./READMEs/README.detailed-latency.md \ ./READMEs/README.esp32.md \ ./READMEs/README.generic-sessions.md \ ./READMEs/README.generic-table.md \ - ./READMEs/README.test-apps.md \ + ./READMEs/README.h2-long-poll.md \ + ./READMEs/README.http-fallback.md \ + ./READMEs/README.lws_dll.md \ + ./READMEs/README.lws_sequencer.md \ + ./READMEs/README.lws_struct.md \ + ./READMEs/README.lws_sul.md \ + ./READMEs/README.lwsws.md \ ./READMEs/README-plugin-sshd-base.md \ ./READMEs/README.plugin-acme.md \ + ./READMEs/README.porting.md \ + ./READMEs/README.problems.md \ + ./READMEs/README.release-policy.md \ + ./READMEs/README.test-apps.md \ + ./READMEs/README.unix-domain-reverse-proxy.md \ + ./READMEs/README.vulnerability-reporting.md \ ./doc-assets INPUT_ENCODING = UTF-8 FILE_PATTERNS = lib/*.c *.md *.png include/*.h