From 2daad4f5ff33d9e294101c2bf4612e8d22fced6a Mon Sep 17 00:00:00 2001 From: Benjamin Valentin Date: Sat, 30 Apr 2022 00:20:26 +0200 Subject: [PATCH] nanocoap: document coap_handler_t --- sys/include/net/nanocoap.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/sys/include/net/nanocoap.h b/sys/include/net/nanocoap.h index d8d7a88f56..c8af5b3259 100644 --- a/sys/include/net/nanocoap.h +++ b/sys/include/net/nanocoap.h @@ -258,6 +258,14 @@ typedef struct _coap_request_ctx coap_request_ctx_t; * * For POST, PATCH and other non-idempotent methods, this is an additional * requirement introduced by the contract of this type. + * + * @param[in] pkt The request packet + * @param[out] buf Buffer for the response + * @param[in] len Size of the response buffer + * @param[in] context Request context + * + * @return Number of response bytes written on success + * Negative error on failure */ typedef ssize_t (*coap_handler_t)(coap_pkt_t *pkt, uint8_t *buf, size_t len, coap_request_ctx_t *context);