Merge pull request #12838 from kb2ma/gcoap/deprecate_gcoap_finish

net/gcoap: deprecate gcoap_finish()

Author: miri64

sys/include/net/gcoap.h

@@ -388,6 +388,9 @@ extern "C" {
  *
  * Accommodates writing Content-Format option in gcoap_finish(). May set to
  * zero if function not used.
+ *
+ * @deprecated  Will not be available after the 2020.07 release. Used only by
+ * gcoap_finish(), which also is deprecated.
  */
 #ifndef GCOAP_REQ_OPTIONS_BUF
 #define GCOAP_REQ_OPTIONS_BUF   (4)
@@ -398,6 +401,9 @@ extern "C" {
  *
  * Accommodates writing Content-Format option in gcoap_finish(). May set to
  * zero if function not used.
+ *
+ * @deprecated  Will not be available after the 2020.07 release. Used only by
+ * gcoap_finish(), which also is deprecated.
  */
 #ifndef GCOAP_RESP_OPTIONS_BUF
 #define GCOAP_RESP_OPTIONS_BUF  (4)
@@ -408,6 +414,9 @@ extern "C" {
  *
  * Accommodates writing Content-Format option in gcoap_finish(). May set to
  * zero if function not used.
+ *
+ * @deprecated  Will not be available after the 2020.07 release. Used only by
+ * gcoap_finish(), which also is deprecated.
  */
 #ifndef GCOAP_OBS_OPTIONS_BUF
 #define GCOAP_OBS_OPTIONS_BUF   (4)
@@ -739,6 +748,9 @@ int gcoap_req_init(coap_pkt_t *pdu, uint8_t *buf, size_t len,
  * Assumes the PDU has been initialized with a gcoap_xxx_init() function, like
  * gcoap_req_init().
  *
+ * @deprecated  Will not be available after the 2020.07 release. Use
+ * coap_opt_finish() instead.
+ *
  * @warning To use this function, you only may have added an Option with
  * option number less than COAP_OPT_CONTENT_FORMAT. Otherwise, use the
  * struct-based API described with @link net_nanocoap nanocoap. @endlink With