1
0
Fork 0
mirror of https://github.com/rest-client/rest-client.git synced 2022-11-09 13:49:40 -05:00

Replace rdoc with yard in dependencies.

This commit is contained in:
Andy Brody 2017-05-28 02:45:49 -04:00
parent 6ff7ce0ce0
commit 3001348c8a
5 changed files with 14 additions and 12 deletions

4
.yardopts Normal file
View file

@ -0,0 +1,4 @@
-
history.md
LICENSE
README.md

View file

@ -120,13 +120,6 @@ end
############################
require 'rdoc/task'
Rake::RDocTask.new do |t|
t.rdoc_dir = 'rdoc'
t.title = "rest-client, fetch RESTful resources effortlessly"
t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
t.options << '--charset' << 'utf-8'
t.rdoc_files.include('README.md')
t.rdoc_files.include('lib/*.rb')
require 'yard'
YARD::Rake::YardocTask.new do |t|
end

View file

@ -13,10 +13,15 @@ end
module RestClient
# This class is used internally by RestClient to send the request, but you can also
# call it directly if you'd like to use a method not supported by the
# main API. For example:
# main API.
#
# @example using {.execute} class method:
# RestClient::Request.execute(method: :head, url: 'http://example.com')
#
# @example initializing {#initialize} and then calling {#execute}:
# req = RestClient::Request.new(method: :get, url: 'http://example.com', timeout: 5)
# req.execute
#
# The `:method` and `:url` parameters are required. All others are optional.
#
# @deprecated *Note:*

View file

@ -108,7 +108,7 @@ module RestClient
#
# @return [String] A string appropriate for use as an HTTP query string
#
# @see {flatten_params}
# @see .flatten_params
#
# @see URI.encode_www_form
#

View file

@ -20,8 +20,8 @@ Gem::Specification.new do |s|
s.add_development_dependency('rspec', '~> 3.0')
s.add_development_dependency('pry', '~> 0')
s.add_development_dependency('pry-doc', '~> 0')
s.add_development_dependency('rdoc', '>= 2.4.2', '< 6.0')
s.add_development_dependency('rubocop', '~> 0')
s.add_development_dependency('yard', '~> 0.9')
s.add_dependency('http-cookie', '>= 1.0.2', '< 2.0')
s.add_dependency('mime-types', '>= 1.16', '< 4.0')