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 2018/03/21 13:13:34 UTC
[3/4] qpid-proton git commit: NO-JIRA: [ruby] Only document the Qpid
module in yard docs.
NO-JIRA: [ruby] Only document the Qpid module in yard docs.
Hide documentation of URI and Array monkey-patching.
Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/6fb0a94a
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/6fb0a94a
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/6fb0a94a
Branch: refs/heads/master
Commit: 6fb0a94a69ca46d597f0b280628e007106248a0a
Parents: c230552
Author: Alan Conway <ac...@redhat.com>
Authored: Tue Mar 20 18:09:42 2018 -0400
Committer: Alan Conway <ac...@redhat.com>
Committed: Wed Mar 21 09:13:14 2018 -0400
----------------------------------------------------------------------
proton-c/bindings/ruby/lib/core/uri.rb | 17 +++++++----------
proton-c/bindings/ruby/lib/qpid_proton.rb | 1 +
proton-c/bindings/ruby/yard/options | 2 +-
3 files changed, 9 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/6fb0a94a/proton-c/bindings/ruby/lib/core/uri.rb
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/lib/core/uri.rb b/proton-c/bindings/ruby/lib/core/uri.rb
index 7518ce1..9c063b8 100644
--- a/proton-c/bindings/ruby/lib/core/uri.rb
+++ b/proton-c/bindings/ruby/lib/core/uri.rb
@@ -43,19 +43,16 @@ module Qpid::Proton
public
- # Convert +s+ to a {URI::AMQP} or {URI::AMQPS} object
+ # Convert +s+ to an amqp: or amqps: URI
#
- # Shortcut strings like "host:port" are allowed: an "amqp://" prefix is added if +s+ does
- # not already look like an 'amqp:', 'amqps:' URI.
- #
- # @note this does not give the same result as a standard URI parser in all cases.
- # For standard conversion to a URI use: {#URI}(s)
+ # This does not give the same result as the standard URI parser in all cases.
+ # Short-cut strings like "host:port" are allowed, an "amqp://" prefix is added if +s+ does
+ # not already look like an 'amqp:' or 'amqps:' URI.
#
# @param s [String,URI] String to convert to a URI, or a URI object.
- # A URI object with no scheme will be converted to {URI::AMQP}
- # @return [URI::AMQP] A valid {URI::AMQP} or {URI::AMQPS} object
- # @raise [BadURIError] s is a URI object with a non-AMQP scheme
- # @raise [InvalidURIError] s cannot be parsed as a URI or shortcut
+ # @return [URI] A valid AMQP or AMQPS URI
+ # @raise [URI::BadURIError] s is a URI object with a non-AMQP scheme
+ # @raise [URI::InvalidURIError] s cannot be parsed as a URI or shortcut
# @raise [::ArgumentError] s is not a string or URI
#
def self.uri(s)
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/6fb0a94a/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 18f3ddd..c446a79 100644
--- a/proton-c/bindings/ruby/lib/qpid_proton.rb
+++ b/proton-c/bindings/ruby/lib/qpid_proton.rb
@@ -26,6 +26,7 @@ rescue LoadError
require "kconv" # Ruby < 1.9
end
+# @api qpid
# Qpid is the top level module for the Qpid project http://qpid.apache.org
# Definitions for this library are in module {Qpid::Proton}
module Qpid
http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/6fb0a94a/proton-c/bindings/ruby/yard/options
----------------------------------------------------------------------
diff --git a/proton-c/bindings/ruby/yard/options b/proton-c/bindings/ruby/yard/options
index 6dad9cb..166989d 100644
--- a/proton-c/bindings/ruby/yard/options
+++ b/proton-c/bindings/ruby/yard/options
@@ -5,4 +5,4 @@
--default-return ""
--hide-void-return
--template default
-
+--api qpid
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org