Skip to content

Commit

Permalink
[Platform] docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
fabiopelosin committed Jun 9, 2012
1 parent 05fba7b commit 972cb59
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions lib/cocoapods/platform.rb
@@ -1,9 +1,8 @@
module Pod

# A platform describes a build environment.
# It captures information about the SDK and a deployment target.
#
# A platform represents all the known build environments if its name is nil.
# A platform describes an SDK name and deployment target. If no name
# is provided an instance of this class behaves like nil and represents
# all the known platforms
#
class Platform

Expand Down Expand Up @@ -89,6 +88,8 @@ def name
#
attr_reader :declared_deployment_target

# @todo Deprecate
#
def deployment_target= (version)
@deployment_target = Pod::Version.create(version)
end
Expand Down Expand Up @@ -141,15 +142,16 @@ def to_s
s
end

# @return [Symbol] A Symbol representation of the SDK.
# @return [Symbol] A Symbol representation of the name.
#
def to_sym
name
end

# @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?
name.nil?
Expand Down

0 comments on commit 972cb59

Please sign in to comment.