You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jr...@apache.org on 2017/10/16 22:37:35 UTC
[2/2] qpid-proton git commit: PROTON-1543: Make sure deprecated API
is visibly marked in generated API docs
PROTON-1543: Make sure deprecated API is visibly marked in generated API docs
Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/a49e36db
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/a49e36db
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/a49e36db
Branch: refs/heads/master
Commit: a49e36db8ff9aa9003248ccd78b8a3251162a198
Parents: 7c252e9
Author: Justin Ross <jr...@apache.org>
Authored: Mon Oct 16 15:05:14 2017 -0700
Committer: Justin Ross <jr...@apache.org>
Committed: Mon Oct 16 15:36:13 2017 -0700
----------------------------------------------------------------------
proton-c/include/proton/connection.h | 8 ++++----
proton-c/include/proton/connection_driver.h | 18 +++++++++++++-----
proton-c/include/proton/delivery.h | 4 ++--
proton-c/include/proton/link.h | 6 +++---
proton-c/include/proton/listener.h | 11 -----------
proton-c/include/proton/messenger.h | 2 --
proton-c/include/proton/reactor.h | 3 ++-
proton-c/include/proton/session.h | 6 +++---
proton-c/include/proton/transport.h | 10 +++++-----
proton-c/include/proton/types.h | 2 --
proton-c/include/proton/url.h | 1 -
11 files changed, 32 insertions(+), 39 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/a49e36db/proton-c/include/proton/connection.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/connection.h b/proton-c/include/proton/connection.h
index d08a2c9..4984040 100644
--- a/proton-c/include/proton/connection.h
+++ b/proton-c/include/proton/connection.h
@@ -118,7 +118,7 @@ PN_EXTERN void pn_connection_free(pn_connection_t *connection);
PN_EXTERN void pn_connection_release(pn_connection_t *connection);
/**
- * @deprecated
+ * **Deprecated**
*
* Get additional error information associated with the connection.
*
@@ -158,11 +158,11 @@ PN_EXTERN void pn_connection_collect(pn_connection_t *connection, pn_collector_t
/**
* Get the collector set with pn_connection_collect()
* @return NULL if pn_connection_collect() has not been called.
-*/
+ */
PN_EXTERN pn_collector_t* pn_connection_collector(pn_connection_t *connection);
/**
- * @deprecated
+ * **Deprecated** - Use ::pn_connection_attachments().
*
* Get the application context that is associated with a connection
* object.
@@ -176,7 +176,7 @@ PN_EXTERN pn_collector_t* pn_connection_collector(pn_connection_t *connection);
PN_EXTERN void *pn_connection_get_context(pn_connection_t *connection);
/**
- * @deprecated
+ * **Deprecated** - Use ::pn_connection_attachments().
*
* Set a new application context for a connection object.
*
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/a49e36db/proton-c/include/proton/connection_driver.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/connection_driver.h b/proton-c/include/proton/connection_driver.h
index 7bd32ef..d0ad150 100644
--- a/proton-c/include/proton/connection_driver.h
+++ b/proton-c/include/proton/connection_driver.h
@@ -98,7 +98,7 @@ typedef struct pn_connection_driver_t {
* Set connection and transport to the provided values, or create a new
* @ref pn_connection_t or @ref pn_transport_t if either is NULL.
* The provided values belong to the connection driver and will be freed by
- * pn_connection_driver_destroy()
+ * pn_connection_driver_destroy().
*
* The transport is bound automatically after the PN_CONNECTION_INIT has been is
* handled by the application. It can be bound earlier with
@@ -106,7 +106,7 @@ typedef struct pn_connection_driver_t {
*
* The following functions must be called before the transport is
* bound to have effect: pn_connection_set_username(), pn_connection_set_password(),
- * pn_transport_set_server()
+ * pn_transport_set_server().
*
* @return PN_OUT_OF_MEMORY if any allocation fails.
*/
@@ -251,11 +251,19 @@ PN_EXTERN pn_connection_driver_t* pn_event_batch_connection_driver(pn_event_batc
*/
#define PN_TRANSPORT_READ_CLOSED PN_TRANSPORT_TAIL_CLOSED
-/**@deprecated Use pn_transport_log() */
+/**
+ * **Deprecated** - Use pn_transport_log().
+ */
PN_EXTERN void pn_connection_driver_log(pn_connection_driver_t *d, const char *msg);
-/**@deprecated Use pn_transport_logf() */
+
+/**
+ * **Deprecated** - Use pn_transport_logf().
+ */
PN_EXTERN void pn_connection_driver_logf(pn_connection_driver_t *d, const char *fmt, ...);
-/**@deprecated Use pn_transport_vlogf() */
+
+/**
+ * **Deprecated** - Use pn_transport_vlogf().
+ */
PN_EXTERN void pn_connection_driver_vlogf(pn_connection_driver_t *d, const char *fmt, va_list ap);
/**
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/a49e36db/proton-c/include/proton/delivery.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/delivery.h b/proton-c/include/proton/delivery.h
index 00ca11d..8e7f421 100644
--- a/proton-c/include/proton/delivery.h
+++ b/proton-c/include/proton/delivery.h
@@ -68,7 +68,7 @@ PN_EXTERN pn_delivery_tag_t pn_dtag(const char *bytes, size_t size);
PN_EXTERN pn_delivery_t *pn_delivery(pn_link_t *link, pn_delivery_tag_t tag);
/**
- * @deprecated
+ * **Deprecated** - Use ::pn_delivery_attachments().
*
* Get the application context that is associated with a delivery object.
*
@@ -81,7 +81,7 @@ PN_EXTERN pn_delivery_t *pn_delivery(pn_link_t *link, pn_delivery_tag_t tag);
PN_EXTERN void *pn_delivery_get_context(pn_delivery_t *delivery);
/**
- * @deprecated
+ * **Deprecated** - Use ::pn_delivery_attachments().
*
* Set a new application context for a delivery object.
*
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/a49e36db/proton-c/include/proton/link.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/link.h b/proton-c/include/proton/link.h
index 6a5a86c..40f8f62 100644
--- a/proton-c/include/proton/link.h
+++ b/proton-c/include/proton/link.h
@@ -83,7 +83,7 @@ PN_EXTERN pn_link_t *pn_receiver(pn_session_t *session, const char *name);
PN_EXTERN void pn_link_free(pn_link_t *link);
/**
- * @deprecated
+ * **Deprecated** - Use ::pn_link_attachments().
*
* Get the application context that is associated with a link object.
*
@@ -96,7 +96,7 @@ PN_EXTERN void pn_link_free(pn_link_t *link);
PN_EXTERN void *pn_link_get_context(pn_link_t *link);
/**
- * @deprecated
+ * **Deprecated** - Use ::pn_link_attachments().
*
* Set a new application context for a link object.
*
@@ -149,7 +149,7 @@ PN_EXTERN bool pn_link_is_receiver(pn_link_t *link);
PN_EXTERN pn_state_t pn_link_state(pn_link_t *link);
/**
- * @deprecated
+ * **Deprecated**
*
* Get additional error information associated with the link.
*
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/a49e36db/proton-c/include/proton/listener.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/listener.h b/proton-c/include/proton/listener.h
index 974b6df..0994a70 100644
--- a/proton-c/include/proton/listener.h
+++ b/proton-c/include/proton/listener.h
@@ -71,19 +71,8 @@ PNP_EXTERN pn_condition_t *pn_listener_condition(pn_listener_t *l);
* @cond INTERNAL
*/
-/**
- * @deprecated
- *
- * **Deprecated** - Get the application context that is associated
- * with a listener.
- */
PNP_EXTERN void *pn_listener_get_context(pn_listener_t *listener);
-/**
- * @deprecated
- *
- * **Deprecated** - Set a new application context for a listener.
- */
PNP_EXTERN void pn_listener_set_context(pn_listener_t *listener, void *context);
/**
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/a49e36db/proton-c/include/proton/messenger.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/messenger.h b/proton-c/include/proton/messenger.h
index 74c3fc6..3caf272 100644
--- a/proton-c/include/proton/messenger.h
+++ b/proton-c/include/proton/messenger.h
@@ -38,8 +38,6 @@ extern "C" {
*
* @copybrief messenger
*
- * @deprecated
- *
* @addtogroup messenger
* @{
*/
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/a49e36db/proton-c/include/proton/reactor.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/reactor.h b/proton-c/include/proton/reactor.h
index 8d229ab..f617b0d 100644
--- a/proton-c/include/proton/reactor.h
+++ b/proton-c/include/proton/reactor.h
@@ -90,6 +90,8 @@ PNX_EXTERN pn_connection_t *pn_reactor_connection_to_host(pn_reactor_t *reactor,
pn_handler_t *handler);
/**
+ * **Deprecated** - Use ::pn_reactor_connection_to_host().
+ *
* Create an outgoing connection that will be managed by the reactor.
*
* The host address for the connection must be set via
@@ -101,7 +103,6 @@ PNX_EXTERN pn_connection_t *pn_reactor_connection_to_host(pn_reactor_t *reactor,
* @param[in] handler the handler that will process all events generated by
* this connection.
* @return a connection object
- * @deprecated Use ::pn_reactor_connection_to_host() instead.
*/
PNX_EXTERN pn_connection_t *pn_reactor_connection(pn_reactor_t *reactor,
pn_handler_t *handler);
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/a49e36db/proton-c/include/proton/session.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/session.h b/proton-c/include/proton/session.h
index 8c78db4..cabb1f2 100644
--- a/proton-c/include/proton/session.h
+++ b/proton-c/include/proton/session.h
@@ -67,7 +67,7 @@ PN_EXTERN pn_session_t *pn_session(pn_connection_t *connection);
PN_EXTERN void pn_session_free(pn_session_t *session);
/**
- * @deprecated
+ * **Deprecated** - Use ::pn_session_attachments().
*
* Get the application context that is associated with a session
* object.
@@ -81,7 +81,7 @@ PN_EXTERN void pn_session_free(pn_session_t *session);
PN_EXTERN void *pn_session_get_context(pn_session_t *session);
/**
- * @deprecated
+ * **Deprecated** - Use ::pn_session_attachments().
*
* Set a new application context for a session object.
*
@@ -110,7 +110,7 @@ PN_EXTERN pn_record_t *pn_session_attachments(pn_session_t *session);
PN_EXTERN pn_state_t pn_session_state(pn_session_t *session);
/**
- * @deprecated
+ * **Deprecated**
*
* Get additional error information associated with the session.
*
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/a49e36db/proton-c/include/proton/transport.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/transport.h b/proton-c/include/proton/transport.h
index 5c88bab..a32505f 100644
--- a/proton-c/include/proton/transport.h
+++ b/proton-c/include/proton/transport.h
@@ -215,7 +215,7 @@ PN_EXTERN bool pn_transport_is_encrypted(pn_transport_t *transport);
PN_EXTERN pn_condition_t *pn_transport_condition(pn_transport_t *transport);
/**
- * @deprecated
+ * **Deprecated**
*/
PN_EXTERN pn_error_t *pn_transport_error(pn_transport_t *transport);
@@ -271,7 +271,7 @@ PN_EXTERN void pn_transport_set_tracer(pn_transport_t *transport, pn_tracer_t tr
PN_EXTERN pn_tracer_t pn_transport_get_tracer(pn_transport_t *transport);
/**
- * @deprecated
+ * **Deprecated** - Use ::pn_transport_attachments().
*
* Get the application context that is associated with a transport object.
*
@@ -284,7 +284,7 @@ PN_EXTERN pn_tracer_t pn_transport_get_tracer(pn_transport_t *transport);
PN_EXTERN void *pn_transport_get_context(pn_transport_t *transport);
/**
- * @deprecated
+ * **Deprecated** - Use ::pn_transport_attachments().
*
* Set a new application context for a transport object.
*
@@ -458,12 +458,12 @@ PN_EXTERN void pn_transport_set_idle_timeout(pn_transport_t *transport, pn_milli
PN_EXTERN pn_millis_t pn_transport_get_remote_idle_timeout(pn_transport_t *transport);
/**
- * @deprecated
+ * **Deprecated**
*/
PN_EXTERN ssize_t pn_transport_input(pn_transport_t *transport, const char *bytes, size_t available);
/**
- * @deprecated
+ * **Deprecated**
*/
PN_EXTERN ssize_t pn_transport_output(pn_transport_t *transport, char *bytes, size_t size);
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/a49e36db/proton-c/include/proton/types.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/types.h b/proton-c/include/proton/types.h
index 07b3618..9df0cc6 100644
--- a/proton-c/include/proton/types.h
+++ b/proton-c/include/proton/types.h
@@ -120,11 +120,9 @@
* @ingroup io
*
* @defgroup messenger Messenger
- * @deprecated
* @brief **Deprecated** - Use the @ref proactor API or Qpid Proton C++.
*
* @defgroup url URL
- * @deprecated
* @brief **Deprecated** - Use a third-party URL library.
*/
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/a49e36db/proton-c/include/proton/url.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/url.h b/proton-c/include/proton/url.h
index e898aba..ad239ce 100644
--- a/proton-c/include/proton/url.h
+++ b/proton-c/include/proton/url.h
@@ -30,7 +30,6 @@ extern "C" {
* @file
*
* @copybrief url
- * @deprecated
*
* @addtogroup url
* @{
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org