Permalink
Browse files

Change YARD `@api internal` to `@api private` to trigger "private api…

…" message.
  • Loading branch information...
1 parent fba3c75 commit 8ca8811477d1c0954b48cdf04bb05971f766eda7 @weppos committed Jun 27, 2012
Showing with 16 additions and 18 deletions.
  1. +1 −3 README.md
  2. +2 −2 lib/whois.rb
  3. +3 −3 lib/whois/record.rb
  4. +3 −3 lib/whois/record/parser.rb
  5. +4 −4 lib/whois/record/parser/base.rb
  6. +3 −3 lib/whois/server/adapters/base.rb
View
@@ -207,6 +207,4 @@ See the [CHANGELOG](CHANGELOG.md) file for details.
## License
-Copyright (c) 2009-2012 Simone Carletti.
-
-This is Free Software distributed under the MIT license.
+Copyright (c) 2009-2012 Simone Carletti. This is Free Software distributed under the MIT license.
View
@@ -112,7 +112,7 @@ def registered?(qstring)
# @param [String] message The message to display.
# @return [void]
#
- # @api internal
+ # @api private
# @private
def deprecate(message = nil, callstack = caller)
message ||= "You are using deprecated behavior which will be removed from the next major or minor release."
@@ -127,7 +127,7 @@ def deprecate(message = nil, callstack = caller)
# @param [String] message
# @return [void]
#
- # @api internal
+ # @api private
# @private
def bug!(error, message)
raise error, message.dup <<
View
@@ -290,7 +290,7 @@ def response_unavailable?
private
- # @api internal
+ # @api private
def self.define_property_method(method)
class_eval <<-RUBY, __FILE__, __LINE__ + 1
def #{method}(*args, &block)
@@ -301,7 +301,7 @@ def #{method}(*args, &block)
RUBY
end
- # @api internal
+ # @api private
def self.define_method_method(method)
class_eval <<-RUBY, __FILE__, __LINE__ + 1
def #{method}(*args, &block)
@@ -312,7 +312,7 @@ def #{method}(*args, &block)
RUBY
end
- # @api internal
+ # @api private
def self.define_question_method(method)
class_eval <<-RUBY, __FILE__, __LINE__ + 1
def #{method}?
@@ -264,7 +264,7 @@ def response_unavailable?
private
- # @api internal
+ # @api private
def self.define_missing_method(method)
class_eval <<-RUBY, __FILE__, __LINE__ + 1
def #{method}(*args, &block)
@@ -357,7 +357,7 @@ def select_parser(property, status = :any)
nil
end
- # @api internal
+ # @api private
def all_in_parallel?(*args)
count = args.first.size
index = 0
@@ -369,7 +369,7 @@ def all_in_parallel?(*args)
true
end
- # @api internal
+ # @api private
def any_is?(collection, symbol)
collection.any? { |item| item.is(symbol) }
end
@@ -211,12 +211,12 @@ def content
# is(:response_throttled?)
# # => true
#
- # @api internal
+ # @api private
def is(symbol)
respond_to?(symbol) && send(symbol)
end
- # @api internal
+ # @api private
def validate!
raise ResponseIsThrottled if is(:response_throttled?)
raise ResponseIsUnavailable if is(:response_unavailable?)
@@ -365,7 +365,7 @@ def cached_properties_fetch(key)
private
- # @api internal
+ # @api private
def typecast(value, type)
if Array == type
Array.wrap(value)
@@ -374,7 +374,7 @@ def typecast(value, type)
end
end
- # @api internal
+ # @api private
def handle_property(property, *args)
unless property_supported?(property)
return send(:"_property_#{property}", *args)
@@ -44,7 +44,7 @@ class Base
# Temporary internal response buffer.
#
- # @api internal
+ # @api private
# @return [Array]
attr_reader :buffer
@@ -144,7 +144,7 @@ def buffer_append(body, host)
@buffer << Whois::Record::Part.new(:body => body, :host => host)
end
- # @api internal
+ # @api private
def buffer_start
@buffer = []
result = yield(@buffer)
@@ -184,7 +184,7 @@ def query_the_socket(query, host, port = nil)
#
# This is for internal use only!
#
- # @api internal
+ # @api private
def ask_the_socket(query, *args)
client = TCPSocket.new(*args)
client.write("#{query}\r\n") # I could use put(foo) and forget the \n

0 comments on commit 8ca8811

Please sign in to comment.