You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ac...@apache.org on 2015/10/26 17:02:51 UTC

qpid-proton git commit: PROTON-1019: Documentation: typos in the C++ API documentation

Repository: qpid-proton
Updated Branches:
  refs/heads/master e073fad0a -> 5cc0a9e1f


PROTON-1019: Documentation: typos in the C++ API documentation


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

Branch: refs/heads/master
Commit: 5cc0a9e1fbb98eb279426c4784ae5213d5376c66
Parents: e073fad
Author: Otavio Rodolfo Piske <>
Authored: Mon Oct 26 12:00:01 2015 -0400
Committer: Alan Conway <ac...@redhat.com>
Committed: Mon Oct 26 12:00:01 2015 -0400

----------------------------------------------------------------------
 examples/cpp/simple_send.cpp                        | 2 +-
 proton-c/bindings/cpp/include/proton/connection.hpp | 2 +-
 proton-c/bindings/cpp/include/proton/decoder.hpp    | 6 +++---
 proton-c/bindings/cpp/include/proton/encoder.hpp    | 2 +-
 proton-c/bindings/cpp/include/proton/event.hpp      | 2 +-
 proton-c/bindings/cpp/include/proton/types.hpp      | 2 +-
 proton-c/bindings/cpp/src/proton_event.hpp          | 2 +-
 7 files changed, 9 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/5cc0a9e1/examples/cpp/simple_send.cpp
----------------------------------------------------------------------
diff --git a/examples/cpp/simple_send.cpp b/examples/cpp/simple_send.cpp
index d103359..23ab76e 100644
--- a/examples/cpp/simple_send.cpp
+++ b/examples/cpp/simple_send.cpp
@@ -76,7 +76,7 @@ int main(int argc, char **argv) {
     int message_count = 100;
     options opts(argc, argv);
     opts.add_value(address, 'a', "address", "connect and send to URL", "URL");
-    opts.add_value(message_count, 'm', "messages", "receive COUNT messages", "COUNT");
+    opts.add_value(message_count, 'm', "messages", "send COUNT messages", "COUNT");
     try {
         opts.parse();
         simple_send send(address, message_count);

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/5cc0a9e1/proton-c/bindings/cpp/include/proton/connection.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/include/proton/connection.hpp b/proton-c/bindings/cpp/include/proton/connection.hpp
index efbd549..cacf004 100644
--- a/proton-c/bindings/cpp/include/proton/connection.hpp
+++ b/proton-c/bindings/cpp/include/proton/connection.hpp
@@ -57,7 +57,7 @@ class connection : public counted_facade<pn_connection_t, connection, endpoint>
     /** Create a new session */
     PN_CPP_EXTERN class session& open_session();
 
-    /** Default session is created on first call and re-used for the lifeime of the connection */
+    /** Default session is created on first call and re-used for the lifetime of the connection */
     PN_CPP_EXTERN class session& default_session();
 
     /** Create a sender on default_session() with target=addr and optional handler h */

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/5cc0a9e1/proton-c/bindings/cpp/include/proton/decoder.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/include/proton/decoder.hpp b/proton-c/bindings/cpp/include/proton/decoder.hpp
index 28feaf9..0766aba 100644
--- a/proton-c/bindings/cpp/include/proton/decoder.hpp
+++ b/proton-c/bindings/cpp/include/proton/decoder.hpp
@@ -62,7 +62,7 @@ struct rewind{};
  *
  * AMQP maps can be inserted/extracted to any container with pair<X,Y> as
  * value_type, which includes std::map and std::unordered_map but also for
- * example std::vector<std::pair<X,Y> >. This allows you to perserve order when
+ * example std::vector<std::pair<X,Y> >. This allows you to preserve order when
  * extracting AMQP maps.
  *
  * You can also extract container values element-by-element, see decoder::operator>>(decoder&, start&)
@@ -157,7 +157,7 @@ class decoder : public facade<pn_data_t, decoder> {
      *     decoder >> finish();
      *
      * The first value of an ARRAY is a descriptor if start::descriptor is true,
-     * followed by start.size elemets of type start::element.
+     * followed by start.size elements of type start::element.
      *
      * A LIST has start.size elements which may be of mixed type.
      *
@@ -170,7 +170,7 @@ class decoder : public facade<pn_data_t, decoder> {
      * You must always end a complex type by extracting to an instance of `finish`,
      * the decoder::scope automates this.
      *
-     *@throw decoder::error if the curent value is not a container type.
+     *@throw decoder::error if the current value is not a container type.
      */
     PN_CPP_EXTERN friend decoder& operator>>(decoder&, start&);
 

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/5cc0a9e1/proton-c/bindings/cpp/include/proton/encoder.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/include/proton/encoder.hpp b/proton-c/bindings/cpp/include/proton/encoder.hpp
index b931682..7039061 100644
--- a/proton-c/bindings/cpp/include/proton/encoder.hpp
+++ b/proton-c/bindings/cpp/include/proton/encoder.hpp
@@ -113,7 +113,7 @@ class encoder : public facade<pn_data_t, encoder> {
      *
      * Use one of the static functions start::array(), start::list(),
      * start::map() or start::described() to create an appropriate start value
-     * and inser it into the encoder, followed by the contained elements.  For
+     * and insert it into the encoder, followed by the contained elements.  For
      * example:
      *
      *      encoder << start::list() << amqp_int(1) << amqp_symbol("two") << 3.0 << finish();

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/5cc0a9e1/proton-c/bindings/cpp/include/proton/event.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/include/proton/event.hpp b/proton-c/bindings/cpp/include/proton/event.hpp
index 65d8c7b..6fb0c94 100644
--- a/proton-c/bindings/cpp/include/proton/event.hpp
+++ b/proton-c/bindings/cpp/include/proton/event.hpp
@@ -55,7 +55,7 @@ class event {
     virtual PN_CPP_EXTERN class receiver& receiver() const;
     /// Get link @throws error if no link.
     virtual PN_CPP_EXTERN class link& link() const;
-    /// Get delivey @throws error if no delivery.
+    /// Get delivery @throws error if no delivery.
     virtual PN_CPP_EXTERN class delivery& delivery() const;
     /** Get message @throws error if no message. */
     virtual PN_CPP_EXTERN class message &message() const;

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/5cc0a9e1/proton-c/bindings/cpp/include/proton/types.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/include/proton/types.hpp b/proton-c/bindings/cpp/include/proton/types.hpp
index 972f35d..d3944b4 100644
--- a/proton-c/bindings/cpp/include/proton/types.hpp
+++ b/proton-c/bindings/cpp/include/proton/types.hpp
@@ -240,7 +240,7 @@ struct start {
     PN_CPP_EXTERN static start described();
 };
 
-/** Finish insterting or extracting a container value. */
+/** Finish inserting or extracting a container value. */
 struct finish {};
 
 }

http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/5cc0a9e1/proton-c/bindings/cpp/src/proton_event.hpp
----------------------------------------------------------------------
diff --git a/proton-c/bindings/cpp/src/proton_event.hpp b/proton-c/bindings/cpp/src/proton_event.hpp
index 66b8ed9..24ca5e4 100644
--- a/proton-c/bindings/cpp/src/proton_event.hpp
+++ b/proton-c/bindings/cpp/src/proton_event.hpp
@@ -131,7 +131,7 @@ class proton_event : public event
 
     /**
      * The local session endpoint has been opened. Events of this type
-     * point ot the relevant session.
+     * point to the relevant session.
      */
     PN_CPP_EXTERN static const event_type SESSION_LOCAL_OPEN;
 


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