Commit 4cbd1314 authored by Samuel Giddins's avatar Samuel Giddins

Fix BuildSettings docs to pass inch

parent 67d6846e
...@@ -8,7 +8,9 @@ module Pod ...@@ -8,7 +8,9 @@ module Pod
# @!group Constants # @!group Constants
# @return [Set<String>] The build settings that should be treated as arrays, rather than strings. # @return [Set<String>]
# The build settings that should be treated as arrays, rather than strings.
#
PLURAL_SETTINGS = %w( PLURAL_SETTINGS = %w(
ALTERNATE_PERMISSIONS_FILES ALTERNATE_PERMISSIONS_FILES
ARCHS ARCHS
...@@ -33,8 +35,9 @@ module Pod ...@@ -33,8 +35,9 @@ module Pod
WARNING_LDFLAGS WARNING_LDFLAGS
).to_set.freeze ).to_set.freeze
# @return [String] The variable for the configuration build directory used when # @return [String]
# building pod targets. # The variable for the configuration build directory used when building pod targets.
#
CONFIGURATION_BUILD_DIR_VARIABLE = '${PODS_CONFIGURATION_BUILD_DIR}'.freeze CONFIGURATION_BUILD_DIR_VARIABLE = '${PODS_CONFIGURATION_BUILD_DIR}'.freeze
#-------------------------------------------------------------------------# #-------------------------------------------------------------------------#
...@@ -132,7 +135,9 @@ module Pod ...@@ -132,7 +135,9 @@ module Pod
# @!group Public API # @!group Public API
# @return [Set<String>] a set of all the build settings names that will be present in the #xcconfig # @return [Set<String>] a set of all the build settings names that will
# be present in the #xcconfig
#
attr_reader :build_settings_names attr_reader :build_settings_names
end end
...@@ -140,10 +145,16 @@ module Pod ...@@ -140,10 +145,16 @@ module Pod
# @!group Public API # @!group Public API
# @return [Target] The target this # @return [Target]
# The target this build settings object is generating build settings for
#
attr_reader :target attr_reader :target
# @param [Target] target @see #target # Initialize a new instance
#
# @param [Target] target
# see {#target}
#
def initialize(target) def initialize(target)
@target = target @target = target
end end
...@@ -164,11 +175,15 @@ module Pod ...@@ -164,11 +175,15 @@ module Pod
xcconfig xcconfig
end end
# Saves the generated xcconfig to the given path
#
# @return [Xcodeproj::Config] # @return [Xcodeproj::Config]
# #
# @see #xcconfig # @see #xcconfig
# #
# @param [String,Pathname] path # @param [String,Pathname] path
# The path the xcconfig will be saved to
#
def save_as(path) def save_as(path)
xcconfig.save_as(path) xcconfig.save_as(path)
end end
...@@ -428,9 +443,16 @@ module Pod ...@@ -428,9 +443,16 @@ module Pod
attr_reader :test_xcconfig attr_reader :test_xcconfig
alias test_xcconfig? test_xcconfig alias test_xcconfig? test_xcconfig
# @param [PodTarget] target @see #target # Intializes a new instance
#
# @param [PodTarget] target
# see {#target}
#
# @param [String] configuration_name
# see {#configuration_name}
# #
# @param [Boolean] test_xcconfig @see #test_xcconfig? # @param [Boolean] test_xcconfig
# see {#test_xcconfig?}
# #
def initialize(target, test_xcconfig) def initialize(target, test_xcconfig)
super(target) super(target)
...@@ -799,8 +821,14 @@ module Pod ...@@ -799,8 +821,14 @@ module Pod
# The build configuration these settings will be used for # The build configuration these settings will be used for
attr_reader :configuration_name attr_reader :configuration_name
# @param [AggregateTarget] target @see #target # Intializes a new instance
# @param [String] configuration_name @see #configuration_name #
# @param [AggregateTarget] target
# see {#target}
#
# @param [String] configuration_name
# see {#configuration_name}
#
def initialize(target, configuration_name) def initialize(target, configuration_name)
super(target) super(target)
@configuration_name = configuration_name @configuration_name = configuration_name
......
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