You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by gs...@apache.org on 2014/11/26 21:06:13 UTC
[26/35] qpid-proton git commit: NO-JIRA: More Ruby rdoc cleanup.
NO-JIRA: More Ruby rdoc cleanup.
Turn off including the licensing headers repeatedly in the documentation
generated.
Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/23354652
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/23354652
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/23354652
Branch: refs/heads/examples
Commit: 233546525867119f652d4b3ccc5b58ca64878745
Parents: 6a78d2f
Author: Darryl L. Pierce <mc...@gmail.com>
Authored: Fri Nov 21 08:33:50 2014 -0500
Committer: Darryl L. Pierce <mc...@gmail.com>
Committed: Mon Nov 24 08:16:48 2014 -0500
----------------------------------------------------------------------
proton-c/bindings/ruby/lib/qpid_proton.rb | 4 ++--
proton-c/bindings/ruby/lib/qpid_proton/array.rb | 10 +++++-----
proton-c/bindings/ruby/lib/qpid_proton/data.rb | 10 ++++------
proton-c/bindings/ruby/lib/qpid_proton/described.rb | 4 ++--
.../bindings/ruby/lib/qpid_proton/exception_handling.rb | 8 ++++----
proton-c/bindings/ruby/lib/qpid_proton/exceptions.rb | 8 ++++----
proton-c/bindings/ruby/lib/qpid_proton/filters.rb | 8 ++++----
proton-c/bindings/ruby/lib/qpid_proton/hash.rb | 6 +++---
proton-c/bindings/ruby/lib/qpid_proton/mapping.rb | 8 ++++----
proton-c/bindings/ruby/lib/qpid_proton/message.rb | 8 ++++----
proton-c/bindings/ruby/lib/qpid_proton/message_format.rb | 8 ++++----
proton-c/bindings/ruby/lib/qpid_proton/messenger.rb | 4 ++--
proton-c/bindings/ruby/lib/qpid_proton/selectable.rb | 8 ++++----
proton-c/bindings/ruby/lib/qpid_proton/strings.rb | 4 ++--
proton-c/bindings/ruby/lib/qpid_proton/subscription.rb | 8 ++++----
proton-c/bindings/ruby/lib/qpid_proton/tracker.rb | 8 ++++----
proton-c/bindings/ruby/lib/qpid_proton/tracker_status.rb | 8 ++++----
proton-c/bindings/ruby/lib/qpid_proton/version.rb | 11 +++++++----
18 files changed, 67 insertions(+), 66 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton.rb b/proton-c/bindings/ruby/lib/qpid_proton.rb
index 4da4e11..0b7e77c 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,7 +15,7 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
require "cproton"
require "date"
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/array.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/array.rb b/proton-c/bindings/ruby/lib/qpid_proton/array.rb
index 34e1c67..a4294a3 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/array.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/array.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,16 +15,16 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
#--
# Patch the Array class to provide methods for adding its contents
# to a Qpid::Proton::Data instance.
#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
# Holds the information for an AMQP Array compound type.
#
@@ -54,7 +54,7 @@ module Qpid
end
-class Array
+class Array # :nodoc:
# Used to declare an array as an AMQP array.
#
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/data.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/data.rb b/proton-c/bindings/ruby/lib/qpid_proton/data.rb
index 1e515c8..b6b3002 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/data.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/data.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,13 +15,11 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
-
-require 'cproton'
+#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
# +DataError+ is raised when an error occurs while encoding
# or decoding data.
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/described.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/described.rb b/proton-c/bindings/ruby/lib/qpid_proton/described.rb
index adb7f8c..98679c2 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/described.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/described.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,7 +15,7 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
module Qpid # :nodoc:
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/exception_handling.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/exception_handling.rb b/proton-c/bindings/ruby/lib/qpid_proton/exception_handling.rb
index 4dce3ef..fd66865 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/exception_handling.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/exception_handling.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,11 +15,11 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
# Provides mixin functionality for dealing with exception conditions.
#
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/exceptions.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/exceptions.rb b/proton-c/bindings/ruby/lib/qpid_proton/exceptions.rb
index 094f6fe..e3c3d19 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/exceptions.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/exceptions.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,11 +15,11 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
module Error
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/filters.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/filters.rb b/proton-c/bindings/ruby/lib/qpid_proton/filters.rb
index 46c9bf7..370d017 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/filters.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/filters.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,11 +15,11 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
module Filters
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/hash.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/hash.rb b/proton-c/bindings/ruby/lib/qpid_proton/hash.rb
index bd7c1b5..1e19da1 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/hash.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/hash.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,14 +15,14 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
#--
# Patch the Hash class to provide methods for adding its contents
# to a Qpid::Proton::Data instance.
#++
-class Hash
+class Hash # :nodoc:
# Places the contents of the hash into the specified data object.
#
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/mapping.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/mapping.rb b/proton-c/bindings/ruby/lib/qpid_proton/mapping.rb
index 836bcd9..b2e4b86 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/mapping.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/mapping.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,7 +15,7 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
module Qpid # :nodoc:
@@ -110,7 +110,7 @@ module Qpid # :nodoc:
UTFString,
BinaryString])
- class << STRING
+ class << STRING # :nodoc:
def put(data, value)
# if we have a symbol then convert it to a string
value = value.to_s if value.is_a?(Symbol)
@@ -144,7 +144,7 @@ module Qpid # :nodoc:
LIST = Mapping.new(Cproton::PN_LIST, "list", [::Array], "get_array")
MAP = Mapping.new(Cproton::PN_MAP, "map", [::Hash], "get_map")
- class << MAP
+ class << MAP # :nodoc:
def put(data, map)
data.put_map
data.enter
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/message.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/message.rb b/proton-c/bindings/ruby/lib/qpid_proton/message.rb
index b7a4fd0..3077ab1 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/message.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/message.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,11 +15,11 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
# A Message represents an addressable quantity of data.
#
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/message_format.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/message_format.rb b/proton-c/bindings/ruby/lib/qpid_proton/message_format.rb
index 120ff5f..62b6f1a 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/message_format.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/message_format.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,11 +15,11 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
class MessageFormat
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/messenger.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/messenger.rb b/proton-c/bindings/ruby/lib/qpid_proton/messenger.rb
index f17205d..5a16c50 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/messenger.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/messenger.rb
@@ -17,9 +17,9 @@
# under the License.
#
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
# The +Messenger+ class defines a high level interface for
# sending and receiving Messages. Every Messenger contains
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/selectable.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/selectable.rb b/proton-c/bindings/ruby/lib/qpid_proton/selectable.rb
index 34a030f..33554cd 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/selectable.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/selectable.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,11 +15,11 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
# Selectable enables accessing the underlying file descriptors
# for Messenger.
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/strings.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/strings.rb b/proton-c/bindings/ruby/lib/qpid_proton/strings.rb
index d8f5851..44eba02 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/strings.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/strings.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,7 +15,7 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
module Qpid # :nodoc:
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/subscription.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/subscription.rb b/proton-c/bindings/ruby/lib/qpid_proton/subscription.rb
index fbfafea..21d9281 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/subscription.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/subscription.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,11 +15,11 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
# A +Subscription+ is an opaque object for working with a +Messenger+'s
# subscriptions.
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/tracker.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/tracker.rb b/proton-c/bindings/ruby/lib/qpid_proton/tracker.rb
index bf99e30..7de271a 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/tracker.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/tracker.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,11 +15,11 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
# A +Tracker+ is used to track the disposition of a +Message+.
#
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/tracker_status.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/tracker_status.rb b/proton-c/bindings/ruby/lib/qpid_proton/tracker_status.rb
index b74a4c0..81c9ea3 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/tracker_status.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/tracker_status.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,11 +15,11 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
# TrackerStatus contains symbols that represent the status value for a
# Tracker.
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/23354652/proton-c/bindings/ruby/lib/qpid_proton/version.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/qpid_proton/version.rb b/proton-c/bindings/ruby/lib/qpid_proton/version.rb
index 006353c..ebc92c5 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton/version.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton/version.rb
@@ -1,4 +1,4 @@
-#
+#--
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
@@ -15,13 +15,16 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
-#
+#++
-module Qpid
+module Qpid # :nodoc:
- module Proton
+ module Proton # :nodoc:
+ # The major version for the underlying Proton library.
VERSION_MAJOR = Cproton::PN_VERSION_MAJOR
+
+ # The minor version for the underlying Proton library.
VERSION_MINOR = Cproton::PN_VERSION_MINOR
end
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org