qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acon...@apache.org
Subject qpid-proton git commit: NO-JIRA: C++: Fix doc warnings from doxygen.
Date Mon, 15 Aug 2016 13:03:17 GMT
Repository: qpid-proton
Updated Branches:
  refs/heads/master 5afa455a5 -> 49360d1bf


NO-JIRA: C++: Fix doc warnings from doxygen.


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

Branch: refs/heads/master
Commit: 49360d1bf908fbbcdf7989459dea51700e13b319
Parents: 5afa455
Author: Alan Conway <aconway@redhat.com>
Authored: Mon Aug 15 14:00:17 2016 +0100
Committer: Alan Conway <aconway@redhat.com>
Committed: Mon Aug 15 14:02:50 2016 +0100

----------------------------------------------------------------------
 examples/cpp/README.dox                           |  8 ++++----
 examples/cpp/flow_control.cpp                     |  2 +-
 .../bindings/cpp/include/proton/container.hpp     | 18 ++++++++++++++++--
 .../cpp/include/proton/default_container.hpp      |  2 ++
 .../bindings/cpp/include/proton/event_loop.hpp    | 10 ----------
 .../bindings/cpp/include/proton/io/link_namer.hpp |  1 +
 proton-c/bindings/cpp/include/proton/value.hpp    |  4 ++++
 proton-c/include/proton/connection_engine.h       |  1 -
 8 files changed, 28 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/49360d1b/examples/cpp/README.dox
----------------------------------------------------------------------
diff --git a/examples/cpp/README.dox b/examples/cpp/README.dox
index 4d28293..1d46ec8 100644
--- a/examples/cpp/README.dox
+++ b/examples/cpp/README.dox
@@ -139,18 +139,18 @@ __Requires C++11__
 
 */
 
-/** @example schedule_send.cpp
+/** @example scheduled_send.cpp
 
 Shows how to use proton::container::schedule to schedule a timed callback.
 This version uses std::function and so requires C++11 or better. For a C++03 compatible
-approach see @ref schedule_send_03.cpp.
+approach see @ref scheduled_send_03.cpp.
 
 */
 
-/** @example schedule_send_03.cpp
+/** @example scheduled_send_03.cpp
 
 Shows how to use proton::container::schedule to schedule a timed callback in a
-C++03 compatible way. See @ref schedule_send.cpp for a more convenient approach
+C++03 compatible way. See @ref scheduled_send.cpp for a more convenient approach
 using std::function if you have C++11.
 
 */

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/49360d1b/examples/cpp/flow_control.cpp
----------------------------------------------------------------------
diff --git a/examples/cpp/flow_control.cpp b/examples/cpp/flow_control.cpp
index 99f832d..3e7ed4c 100644
--- a/examples/cpp/flow_control.cpp
+++ b/examples/cpp/flow_control.cpp
@@ -109,7 +109,7 @@ class flow_receiver : public proton::messaging_handler {
             if (verbose) std::cout << "Example 1.  Simple use of credit." <<
std::endl;
             // TODO: add timeout callbacks, show no messages until credit.
             example_setup(2);
-            r.add_credit(2);
+            r.add_credit(1);
             break;
         case 1:
             if (r.credit() > 0) return;

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/49360d1b/proton-c/bindings/cpp/include/proton/container.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/include/proton/container.hpp b/proton-c/bindings/cpp/include/proton/container.hpp
index 8524349..5006329 100644
--- a/proton-c/bindings/cpp/include/proton/container.hpp
+++ b/proton-c/bindings/cpp/include/proton/container.hpp
@@ -267,10 +267,11 @@ template <class Ptr>
 class container_ref : public container {
   public:
 #if PN_CPP_HAS_RVALUE_REFERENCES
+    /// Move constructor.
     container_ref(Ptr&& p) : impl_(std::move(p)) {}
 #else
-    // This class will only work correctly if ownership is transferred here
-    // so using std::auto_ptr for Ptr is necessary for pre C++11
+    /// This class will only work correctly if ownership is transferred here
+    /// so using std::auto_ptr for Ptr is necessary for pre C++11
     container_ref(Ptr p) : impl_(p) {}
 #endif
 
@@ -280,36 +281,49 @@ class container_ref : public container {
     listener listen(const std::string& url, const connection_options& opts) { return
impl_->listen(url, opts); }
     listener listen(const std::string& url) { return impl_->listen(url); }
 
+
+    ///@cond INTERNAL
     void stop_listening(const std::string& url) { impl_->stop_listening(url); }
+    ///@endcond
     void run() { impl_->run(); }
     void auto_stop(bool set) { impl_->auto_stop(set); }
 
+    ///@copydoc container::stop
     void stop(const error_condition& err) { impl_->stop(err); }
+    ///@copydoc container::stop
     void stop() { impl_->stop(); }
 
+    ///@copydoc container::open_sender
     returned<sender> open_sender(
         const std::string &url,
         const class sender_options &o,
         const connection_options &c) { return impl_->open_sender(url, o, c); }
+    ///@copydoc container::open_sender
     returned<sender> open_sender(
         const std::string &url,
         const class connection_options &o) { return impl_->open_sender(url, o); }
+    ///@copydoc container::open_sender
     returned<sender> open_sender(
         const std::string &url,
         const class sender_options &o) { return impl_->open_sender(url, o); }
+    ///@copydoc container::open_sender
     returned<sender> open_sender(
         const std::string &url) { return impl_->open_sender(url); }
 
+    ///@copydoc container::open_receiver
     returned<receiver> open_receiver(
         const std::string&url,
         const class receiver_options &o,
         const connection_options &c) { return impl_->open_receiver(url, o, c); }
+    ///@copydoc container::open_receiver
     returned<receiver> open_receiver(
         const std::string&url,
         const class receiver_options &o) { return impl_->open_receiver(url, o); }
+    ///@copydoc container::open_receiver
     returned<receiver> open_receiver(
         const std::string&url,
         const class connection_options &o) { return impl_->open_receiver(url, o);
}
+    ///@copydoc container::open_receiver
     returned<receiver> open_receiver(
         const std::string&url) { return impl_->open_receiver(url); }
 

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/49360d1b/proton-c/bindings/cpp/include/proton/default_container.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/include/proton/default_container.hpp b/proton-c/bindings/cpp/include/proton/default_container.hpp
index ccd5e74..0214490 100644
--- a/proton-c/bindings/cpp/include/proton/default_container.hpp
+++ b/proton-c/bindings/cpp/include/proton/default_container.hpp
@@ -40,11 +40,13 @@ class messaging_handler;
 #endif
 /// Default container factory for C++03, not recommended unless you only have C++03
 PN_CPP_EXTERN std::auto_ptr<container> make_auto_default_container(messaging_handler&,
const std::string& id="");
+/// Default container factory for C++03, not recommended unless you only have C++03
 PN_CPP_EXTERN std::auto_ptr<container> make_auto_default_container(const std::string&
id="");
 
 #if PN_CPP_HAS_UNIQUE_PTR
 /// Default container factory
 PN_CPP_EXTERN std::unique_ptr<container> make_default_container(messaging_handler&,
const std::string& id="");
+/// Default container factory
 PN_CPP_EXTERN std::unique_ptr<container> make_default_container(const std::string&
id="");
 #endif
 

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/49360d1b/proton-c/bindings/cpp/include/proton/event_loop.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/include/proton/event_loop.hpp b/proton-c/bindings/cpp/include/proton/event_loop.hpp
index ae572ce..8288de9 100644
--- a/proton-c/bindings/cpp/include/proton/event_loop.hpp
+++ b/proton-c/bindings/cpp/include/proton/event_loop.hpp
@@ -38,16 +38,6 @@ struct pn_link_t;
 
 namespace proton {
 
-/// **Experimental** - A handler for injected code.
-///
-/// @deprecated use void_function0.
-class inject_handler : public void_function0 {
-  public:
-    virtual ~inject_handler() {}
-    virtual void on_inject() = 0;
-    void operator()() { on_inject(); }
-};
-
 /// **Experimental** - A serial execution context.
 ///
 /// Event handler functions associated with a single proton::connection are called in sequence.

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/49360d1b/proton-c/bindings/cpp/include/proton/io/link_namer.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/include/proton/io/link_namer.hpp b/proton-c/bindings/cpp/include/proton/io/link_namer.hpp
index ac70c4f..a0eea67 100644
--- a/proton-c/bindings/cpp/include/proton/io/link_namer.hpp
+++ b/proton-c/bindings/cpp/include/proton/io/link_namer.hpp
@@ -42,6 +42,7 @@ class link_namer {
     virtual std::string link_name() = 0;
 };
 
+/// *Experimental* - Set the link_namer to use on a connection.
 PN_CPP_EXTERN void set_link_namer(connection&, link_namer&);
 
 } // io

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/49360d1b/proton-c/bindings/cpp/include/proton/value.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/include/proton/value.hpp b/proton-c/bindings/cpp/include/proton/value.hpp
index aa943ed..e7e9f79 100644
--- a/proton-c/bindings/cpp/include/proton/value.hpp
+++ b/proton-c/bindings/cpp/include/proton/value.hpp
@@ -109,6 +109,10 @@ class value : public internal::value_base, private internal::comparable<value>
{
   friend PN_CPP_EXTERN bool operator<(const value& x, const value& y);
     ///@}
 
+    /// If contained value is a scalar type T, print using operator<<(T)
+    ///
+    /// Complex types are printed in a non-standard human-readable format but
+    /// that may change in future so should not be parsed.
   friend PN_CPP_EXTERN std::ostream& operator<<(std::ostream&, const value&);
 };
 

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/49360d1b/proton-c/include/proton/connection_engine.h
----------------------------------------------------------------------
diff --git a/proton-c/include/proton/connection_engine.h b/proton-c/include/proton/connection_engine.h
index 4fdeb85..bf2b69a 100644
--- a/proton-c/include/proton/connection_engine.h
+++ b/proton-c/include/proton/connection_engine.h
@@ -55,7 +55,6 @@
 /// report it to the handler as a  PN_TRANSPORT_ERROR event and return false.
 ///
 /// @defgroup connection_engine The Connection Engine
-/// @ingroup connection_engine
 /// @{
 ///
 


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


Mime
View raw message