Commit 972cb59e authored by Fabio Pelosin's avatar Fabio Pelosin

[Platform] docs.

parent 05fba7b6
module Pod module Pod
# A platform describes a build environment. # A platform describes an SDK name and deployment target. If no name
# It captures information about the SDK and a deployment target. # is provided an instance of this class behaves like nil and represents
# # all the known platforms
# A platform represents all the known build environments if its name is nil.
# #
class Platform class Platform
...@@ -89,6 +88,8 @@ module Pod ...@@ -89,6 +88,8 @@ module Pod
# #
attr_reader :declared_deployment_target attr_reader :declared_deployment_target
# @todo Deprecate
#
def deployment_target= (version) def deployment_target= (version)
@deployment_target = Pod::Version.create(version) @deployment_target = Pod::Version.create(version)
end end
...@@ -141,7 +142,7 @@ module Pod ...@@ -141,7 +142,7 @@ module Pod
s s
end end
# @return [Symbol] A Symbol representation of the SDK. # @return [Symbol] A Symbol representation of the name.
# #
def to_sym def to_sym
name name
...@@ -149,7 +150,8 @@ module Pod ...@@ -149,7 +150,8 @@ module Pod
# @return Whether the platform does not represents any SDK. # @return Whether the platform does not represents any SDK.
# #
# A platform behaves as nil if doesn't specify an SDK and implicitly represents all the available platforms. # @note A platform behaves as nil if doesn't specify an name and
# represents all the known platforms.
# #
def nil? def nil?
name.nil? name.nil?
......
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