qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acon...@apache.org
Subject [70/89] [abbrv] qpid-proton git commit: NO-JIRA: [c, cpp] enable doxygen list of deprecated features
Date Tue, 03 Jul 2018 22:13:59 GMT
NO-JIRA: [c,cpp] enable doxygen list of deprecated features

Fixed doxygen warnings, minor doc fixups.


Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/19ceafa5
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/19ceafa5
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/19ceafa5

Branch: refs/heads/go1
Commit: 19ceafa529a0432eee294200e6f6056f7817038a
Parents: fc1df05
Author: Alan Conway <aconway@redhat.com>
Authored: Mon Apr 23 15:19:01 2018 -0400
Committer: Alan Conway <aconway@redhat.com>
Committed: Mon Apr 23 15:29:55 2018 -0400

----------------------------------------------------------------------
 c/docs/user.doxygen.in       | 4 ----
 c/include/proton/listener.h  | 2 +-
 c/include/proton/message.h   | 2 +-
 c/include/proton/messenger.h | 4 ----
 c/include/proton/netaddr.h   | 9 +++------
 c/include/proton/proactor.h  | 2 +-
 c/include/proton/sasl.h      | 4 ----
 cpp/docs/user.doxygen.in     | 4 ----
 cpp/include/proton/null.hpp  | 2 ++
 9 files changed, 8 insertions(+), 25 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/19ceafa5/c/docs/user.doxygen.in
----------------------------------------------------------------------
diff --git a/c/docs/user.doxygen.in b/c/docs/user.doxygen.in
index 96c272c..03324ee 100644
--- a/c/docs/user.doxygen.in
+++ b/c/docs/user.doxygen.in
@@ -77,10 +77,6 @@ EXAMPLE_RECURSIVE       = YES
 
 DISABLE_INDEX           = YES
 GENERATE_TREEVIEW       = YES
-GENERATE_TODOLIST       = NO
-GENERATE_TESTLIST       = NO
-GENERATE_BUGLIST        = NO
-GENERATE_DEPRECATEDLIST = NO
 IGNORE_PREFIX           = pn_ PN_
 
 # Configuration options related to the output format

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/19ceafa5/c/include/proton/listener.h
----------------------------------------------------------------------
diff --git a/c/include/proton/listener.h b/c/include/proton/listener.h
index 9ad9ecb..72f62c3 100644
--- a/c/include/proton/listener.h
+++ b/c/include/proton/listener.h
@@ -72,7 +72,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 Equivalent to pn_listener_accept2(listener, connection, NULL)
+ * @deprecated Use pn_listener_accept2(listener, connection, NULL)
  */
 PNP_EXTERN void pn_listener_accept(pn_listener_t* listener, pn_connection_t *connection);
 

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/19ceafa5/c/include/proton/message.h
----------------------------------------------------------------------
diff --git a/c/include/proton/message.h b/c/include/proton/message.h
index d7b9663..d30cde6 100644
--- a/c/include/proton/message.h
+++ b/c/include/proton/message.h
@@ -743,7 +743,7 @@ struct pn_link_t;
  * Encode and send a message on a sender link.
  *
  * Performs the following steps:
- * - create or expand the buffer @buf as required
+ * - create or expand the buffer @p buf as required
  * - call pn_message_encode() to encode the message to a buffer
  * - call pn_link_send() to send the encoded message bytes
  * - call pn_link_advance() to indicate the message is complete

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/19ceafa5/c/include/proton/messenger.h
----------------------------------------------------------------------
diff --git a/c/include/proton/messenger.h b/c/include/proton/messenger.h
index 0445865..3d468d6 100644
--- a/c/include/proton/messenger.h
+++ b/c/include/proton/messenger.h
@@ -155,10 +155,6 @@ typedef struct pn_messenger_t pn_messenger_t;
 
 /**
  * A subscription is a request for incoming messages.
- *
- * @todo currently the subscription API is under developed, this
- * should allow more explicit control over subscription properties and
- * behaviour
  */
 typedef struct pn_subscription_t pn_subscription_t;
 

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/19ceafa5/c/include/proton/netaddr.h
----------------------------------------------------------------------
diff --git a/c/include/proton/netaddr.h b/c/include/proton/netaddr.h
index 1ac8c21..39e5478 100644
--- a/c/include/proton/netaddr.h
+++ b/c/include/proton/netaddr.h
@@ -105,15 +105,12 @@ 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);
 
-/* These function names will be deprecated in a future release of proton */
-/**  @deprecated @{ */
-/* PN_DEPRECATED("use pn_transport_local_addr") */
+/**  @deprecated Use pn_transport_local_addr */
 PNP_EXTERN const pn_netaddr_t *pn_netaddr_local(pn_transport_t *t);
-/* PN_DEPRECATED("use pn_transport_remote_addr()") */
+/**  @deprecated Use pn_transport_remote_addr() */
 PNP_EXTERN const pn_netaddr_t *pn_netaddr_remote(pn_transport_t *t);
-/* PN_DEPRECATED("use pn_listener_addr()") */
+/** @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/19ceafa5/c/include/proton/proactor.h
----------------------------------------------------------------------
diff --git a/c/include/proton/proactor.h b/c/include/proton/proactor.h
index 77e0d84..2004be5 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 Equivalent to pn_proactor_connect2(proactor, connection, NULL, addr)
+ * @deprecated Use pn_proactor_connect2(proactor, connection, NULL, addr)
  */
 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/19ceafa5/c/include/proton/sasl.h
----------------------------------------------------------------------
diff --git a/c/include/proton/sasl.h b/c/include/proton/sasl.h
index 90b08f5..03d784e 100644
--- a/c/include/proton/sasl.h
+++ b/c/include/proton/sasl.h
@@ -91,15 +91,11 @@ PN_EXTERN bool pn_sasl_extended(void);
  * Set the outcome of SASL negotiation
  *
  * Used by the server to set the result of the negotiation process.
- *
- * @todo
  */
 PN_EXTERN void pn_sasl_done(pn_sasl_t *sasl, pn_sasl_outcome_t outcome);
 
 /**
  * Retrieve the outcome of SASL negotiation.
- *
- * @todo
  */
 PN_EXTERN pn_sasl_outcome_t pn_sasl_outcome(pn_sasl_t *sasl);
 

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/19ceafa5/cpp/docs/user.doxygen.in
----------------------------------------------------------------------
diff --git a/cpp/docs/user.doxygen.in b/cpp/docs/user.doxygen.in
index 2b2eda6..30aa5d1 100644
--- a/cpp/docs/user.doxygen.in
+++ b/cpp/docs/user.doxygen.in
@@ -70,10 +70,6 @@ EXAMPLE_RECURSIVE       = YES
 
 DISABLE_INDEX           = YES
 GENERATE_TREEVIEW       = YES
-GENERATE_TODOLIST       = NO
-GENERATE_TESTLIST       = NO
-GENERATE_BUGLIST        = NO
-GENERATE_DEPRECATEDLIST = NO
 
 # Configuration options related to the output format
 

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/19ceafa5/cpp/include/proton/null.hpp
----------------------------------------------------------------------
diff --git a/cpp/include/proton/null.hpp b/cpp/include/proton/null.hpp
index 849c199..144ba33 100644
--- a/cpp/include/proton/null.hpp
+++ b/cpp/include/proton/null.hpp
@@ -39,10 +39,12 @@ class null {
   public:
     null() {}
 #if PN_CPP_HAS_NULLPTR
+    /// Constructed from nullptr literal
     null(decltype(nullptr)) {}
 #endif
 };
 
+/// Print a null value
 PN_CPP_EXTERN std::ostream& operator<<(std::ostream&, const null&);
 
 }


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


Mime
View raw message