From 89eb7d5c612bf80e223367e88f20d55d7fbea252 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Thu, 7 Nov 2024 23:19:23 -0800 Subject: Document a number of things as deprecated. This does not fully mark them in the headers, to avoid complicating test suites and such, for now. --- docs/man/nng_stream_dialer_get.3str.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/man/nng_stream_dialer_get.3str.adoc') diff --git a/docs/man/nng_stream_dialer_get.3str.adoc b/docs/man/nng_stream_dialer_get.3str.adoc index 4023e56f..03dbd534 100644 --- a/docs/man/nng_stream_dialer_get.3str.adoc +++ b/docs/man/nng_stream_dialer_get.3str.adoc @@ -1,6 +1,6 @@ = nng_stream_dialer_get(3str) // -// Copyright 2020 Staysail Systems, Inc. +// Copyright 2024 Staysail Systems, Inc. // Copyright 2018 Capitar IT Group BV // Copyright 2019 Devolutions // @@ -42,7 +42,7 @@ int nng_stream_dialer_get_uint64(nng_stream_dialer *d, const char *opt, uint64_t == DESCRIPTION -The `nng_stream_dialer_get()` functions are used to retrieve option values for the +The `nng_stream_dialer_get()` functions are used to retrieve option values for the xref:nng_stream_dialer.5.adoc[byte stream dialer] _d_. The actual options that may be retrieved in this way vary. @@ -76,7 +76,7 @@ It is acceptable to pass `NULL` for _val_ if the value in _sizep_ is zero. This can be used to determine the size of the buffer needed to receive the object. + -TIP: It may be easier to use one of the typed forms of this function. +NOTE: This function is deprecated. Use one of the typed functions instead. `nng_stream_dialer_get_bool()`:: This function is for options which take a Boolean (`bool`). -- cgit v1.2.3-70-g09d2