net: coap: Update documentation for adding options

LukasWoodtli · carlescufi · commit 1018ffe88518 · 2023-08-16T17:06:41.000+02:00
CoAP options do not need to be added in the order of
their code number. The function documentation is updated
accordingly.

Signed-off-by: Lukas Woodtli &lt;lukas.woodtli@husqvarnagroup.com&gt;
diff --git a/include/zephyr/net/coap.h b/include/zephyr/net/coap.h
@@ -442,9 +442,8 @@ int coap_find_options(const struct coap_packet *cpkt, uint16_t code,
 /**
  * @brief Appends an option to the packet.
  *
- * Note: options must be added in numeric order of their codes. Otherwise
- * error will be returned.
- * TODO: Add support for placing options according to its delta value.
+ * Note: options can be added out of numeric order of their codes. But
+ * it's more efficient to add them in order.
  *
  * @param cpkt Packet to be updated
  * @param code Option code to add to the packet, see #coap_option_num

Original file line number	Diff line number	Diff line change
`@@ -442,9 +442,8 @@ int coap_find_options(const struct coap_packet *cpkt, uint16_t code,`
`442`	`442`	`/**`
`443`	`443`	`* @brief Appends an option to the packet.`
`444`	`444`	`*`
`445`		`- * Note: options must be added in numeric order of their codes. Otherwise`
`446`		`- * error will be returned.`
`447`		`- * TODO: Add support for placing options according to its delta value.`
	`445`	`+ * Note: options can be added out of numeric order of their codes. But`
	`446`	`+ * it's more efficient to add them in order.`
`448`	`447`	`*`
`449`	`448`	`* @param cpkt Packet to be updated`
`450`	`449`	`* @param code Option code to add to the packet, see #coap_option_num`