Repository: qpid-proton Updated Branches: refs/heads/master 70bbdd136 -> c037704a7
PROTON-1921: Avoid @deprecated and use the standard bold labels; add docs to listener context accessors Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/e5a0e2a1 Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/e5a0e2a1 Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/e5a0e2a1 Branch: refs/heads/master Commit: e5a0e2a1b38c42febb5f2b0b01a6ba935ed085e5 Parents: 70bbdd1 Author: Justin Ross <jr...@apache.org> Authored: Tue Aug 28 06:27:56 2018 -0700 Committer: Justin Ross <jr...@apache.org> Committed: Tue Aug 28 06:27:56 2018 -0700 ---------------------------------------------------------------------- c/include/proton/import_export.h | 17 ++++++++--------- c/include/proton/listener.h | 22 ++++++++++++++++------ c/include/proton/netaddr.h | 12 +++++++++--- c/include/proton/proactor.h | 2 +- c/include/proton/sasl.h | 5 +++-- 5 files changed, 37 insertions(+), 21 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/e5a0e2a1/c/include/proton/import_export.h ---------------------------------------------------------------------- diff --git a/c/include/proton/import_export.h b/c/include/proton/import_export.h index 951396b..a79e905 100644 --- a/c/include/proton/import_export.h +++ b/c/include/proton/import_export.h @@ -24,17 +24,16 @@ /** * @cond INTERNAL + * + * Compiler specific mechanisms for managing the import and export of + * symbols between shared objects. + * + * PN_EXPORT - Export declaration + * PN_IMPORT - Import declaration */ -/* - Compiler specific mechanisms for managing the import and export of - symbols between shared objects. - PN_EXPORT - Export declaration - PN_IMPORT - Import declaration -*/ - #if defined(_WIN32) && !defined(PROTON_DECLARE_STATIC) -/* Import and Export definitions for Windows: */ +/* Import and Export definitions for Windows */ # define PN_EXPORT __declspec(dllexport) # define PN_IMPORT __declspec(dllimport) #else @@ -43,7 +42,6 @@ # define PN_IMPORT #endif - /* For core proton library symbols */ #if defined(qpid_proton_core_EXPORTS) || defined(qpid_proton_EXPORTS) # define PN_EXTERN PN_EXPORT @@ -79,6 +77,7 @@ #ifndef PN_DEPRECATED # define PN_DEPRECATED(message) #endif + /** * @endcond */ http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/e5a0e2a1/c/include/proton/listener.h ---------------------------------------------------------------------- diff --git a/c/include/proton/listener.h b/c/include/proton/listener.h index bcac451..e4bbf35 100644 --- a/c/include/proton/listener.h +++ b/c/include/proton/listener.h @@ -77,7 +77,7 @@ PNP_EXTERN void pn_listener_free(pn_listener_t *l); PNP_EXTERN void pn_listener_accept2(pn_listener_t *listener, pn_connection_t *connection, pn_transport_t *transport); /** - * @deprecated Use pn_listener_accept2(listener, connection, NULL) + * **Deprecated** - Use ::pn_listener_accept2(). */ PNP_EXTERN void pn_listener_accept(pn_listener_t* listener, pn_connection_t *connection); @@ -87,16 +87,26 @@ PNP_EXTERN void pn_listener_accept(pn_listener_t* listener, pn_connection_t *con PNP_EXTERN pn_condition_t *pn_listener_condition(pn_listener_t *l); /** - * @cond INTERNAL + * Get the application context associated with this listener object. + * + * The application context for a connection may be set using + * ::pn_listener_set_context. + * + * @param[in] listener the listener whose context is to be returned. + * @return the application context for the listener object */ - PNP_EXTERN void *pn_listener_get_context(pn_listener_t *listener); -PNP_EXTERN void pn_listener_set_context(pn_listener_t *listener, void *context); - /** - * @endcond + * Set a new application context for a listener object. + * + * The application context for a listener object may be retrieved + * using ::pn_listener_get_context. + * + * @param[in] listener the listener object + * @param[in] context the application context */ +PNP_EXTERN void pn_listener_set_context(pn_listener_t *listener, void *context); /** * Get the attachments that are associated with a listener object. http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/e5a0e2a1/c/include/proton/netaddr.h ---------------------------------------------------------------------- diff --git a/c/include/proton/netaddr.h b/c/include/proton/netaddr.h index cf4791c..1391ce8 100644 --- a/c/include/proton/netaddr.h +++ b/c/include/proton/netaddr.h @@ -105,15 +105,21 @@ PNP_EXTERN size_t pn_netaddr_socklen(const pn_netaddr_t *na); */ PNP_EXTERN int pn_netaddr_host_port(const pn_netaddr_t* na, char *host, size_t hlen, char *port, size_t plen); -/** @deprecated Use pn_transport_local_addr */ +/** + * **Deprecated** - Use ::pn_transport_local_addr() + */ PN_DEPRECATED("use pn_transport_local_addr") PNP_EXTERN const pn_netaddr_t *pn_netaddr_local(pn_transport_t *t); -/** @deprecated Use pn_transport_remote_addr() */ +/** + * **Deprecated** - Use ::pn_transport_remote_addr() + */ PN_DEPRECATED("use pn_transport_remote_addr()") PNP_EXTERN const pn_netaddr_t *pn_netaddr_remote(pn_transport_t *t); -/** @deprecated Use pn_listener_addr() */ +/** + * **Deprecated** - Use ::pn_listener_addr() + */ PN_DEPRECATED("use pn_listener_addr()") PNP_EXTERN const pn_netaddr_t *pn_netaddr_listening(pn_listener_t *l); http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/e5a0e2a1/c/include/proton/proactor.h ---------------------------------------------------------------------- diff --git a/c/include/proton/proactor.h b/c/include/proton/proactor.h index 2004be5..d4fbdd8 100644 --- a/c/include/proton/proactor.h +++ b/c/include/proton/proactor.h @@ -122,7 +122,7 @@ PNP_EXTERN void pn_proactor_free(pn_proactor_t *proactor); PNP_EXTERN void pn_proactor_connect2(pn_proactor_t *proactor, pn_connection_t *connection, pn_transport_t *transport, const char *addr); /** - * @deprecated Use pn_proactor_connect2(proactor, connection, NULL, addr) + * **Deprecated** - Use ::pn_proactor_connect2() */ PNP_EXTERN void pn_proactor_connect(pn_proactor_t *proactor, pn_connection_t *connection, const char *addr); http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/e5a0e2a1/c/include/proton/sasl.h ---------------------------------------------------------------------- diff --git a/c/include/proton/sasl.h b/c/include/proton/sasl.h index a058ded..251471e 100644 --- a/c/include/proton/sasl.h +++ b/c/include/proton/sasl.h @@ -91,11 +91,12 @@ PN_EXTERN pn_sasl_t *pn_sasl(pn_transport_t *transport); PN_EXTERN bool pn_sasl_extended(void); /** + * **Deprecated** - Do not use. There is no correct way to use this + * API. + * * Set the outcome of SASL negotiation * * Used by the server to set the result of the negotiation process. - * - * @deprecated Do not use - there is no correct way to use this API */ PN_EXTERN void pn_sasl_done(pn_sasl_t *sasl, pn_sasl_outcome_t outcome); --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
