Commit fde74d05 authored by Samuel E. Giddins's avatar Samuel E. Giddins

[Documentation] Add missing downloader cache params

parent 979b1f4f
...@@ -23,7 +23,7 @@ module Pod ...@@ -23,7 +23,7 @@ module Pod
# Downloads the Pod from the given `request` # Downloads the Pod from the given `request`
# #
# @param [Request] request # @param [Request] request
# the request to be downloaded # the request to be downloaded.
# #
# @return [Response] the response from downloading `request` # @return [Response] the response from downloading `request`
# #
...@@ -38,6 +38,13 @@ module Pod ...@@ -38,6 +38,13 @@ module Pod
private private
# @param [Request] request
# the request to be downloaded.
#
# @param [Hash<Symbol,String>] slug_opts
# the download options that should be used in constructing the
# cache slug for this request.
#
# @return [Pathname] The path for the Pod downloaded from the given # @return [Pathname] The path for the Pod downloaded from the given
# `request`. # `request`.
# #
...@@ -45,6 +52,13 @@ module Pod ...@@ -45,6 +52,13 @@ module Pod
root + request.slug(slug_opts) root + request.slug(slug_opts)
end end
# @param [Request] request
# the request to be downloaded.
#
# @param [Hash<Symbol,String>] slug_opts
# the download options that should be used in constructing the
# cache slug for this request.
#
# @return [Pathname] The path for the podspec downloaded from the given # @return [Pathname] The path for the podspec downloaded from the given
# `request`. # `request`.
# #
...@@ -53,6 +67,9 @@ module Pod ...@@ -53,6 +67,9 @@ module Pod
path.sub_ext('.podspec.json') path.sub_ext('.podspec.json')
end end
# @param [Request] request
# the request to be downloaded.
#
# @return [Response] The download response for the given `request` that # @return [Response] The download response for the given `request` that
# was found in the download cache. # was found in the download cache.
# #
...@@ -63,6 +80,9 @@ module Pod ...@@ -63,6 +80,9 @@ module Pod
Response.new(path, spec, request.params) Response.new(path, spec, request.params)
end end
# @param [Request] request
# the request to be downloaded.
#
# @return [Specification] The cached specification for the given # @return [Specification] The cached specification for the given
# `request`. # `request`.
# #
...@@ -71,6 +91,9 @@ module Pod ...@@ -71,6 +91,9 @@ module Pod
path.file? && Specification.from_file(path) path.file? && Specification.from_file(path)
end end
# @param [Request] request
# the request to be downloaded.
#
# @return [Response] The download response for the given `request` that # @return [Response] The download response for the given `request` that
# was not found in the download cache. # was not found in the download cache.
# #
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment