Commit d0081ee0 authored by Samuel Giddins's avatar Samuel Giddins

[Docs] Add docs for user_project properties

parent 74f45278
...@@ -36,6 +36,8 @@ module Pod ...@@ -36,6 +36,8 @@ module Pod
# #
attr_accessor :recommends_frameworks attr_accessor :recommends_frameworks
# @return [Xcodeproj::Project] the user's Xcode project
#
attr_accessor :project attr_accessor :project
end end
end end
......
...@@ -25,6 +25,8 @@ module Pod ...@@ -25,6 +25,8 @@ module Pod
# Inspect the #target_definition # Inspect the #target_definition
# #
# @raise If no `user_project` is set
#
# @return [TargetInspectionResult] # @return [TargetInspectionResult]
# #
def compute_results def compute_results
...@@ -74,6 +76,9 @@ module Pod ...@@ -74,6 +76,9 @@ module Pod
path path
end end
# @return [Xcodeproj::Project] the user's Xcode project, used for target
# inspection
#
attr_accessor :user_project attr_accessor :user_project
#-----------------------------------------------------------------------# #-----------------------------------------------------------------------#
......
...@@ -8,6 +8,8 @@ module Pod ...@@ -8,6 +8,8 @@ module Pod
# #
attr_accessor :sandbox_root attr_accessor :sandbox_root
# @return [Project] The Pods Xcode project.
#
attr_accessor :pods_project attr_accessor :pods_project
# @return [Array<UmbrellaTargetDescription>] The list of # @return [Array<UmbrellaTargetDescription>] The list of
...@@ -50,6 +52,9 @@ module Pod ...@@ -50,6 +52,9 @@ module Pod
# Pure data class which describes and umbrella target. # Pure data class which describes and umbrella target.
# #
class UmbrellaTargetDescription class UmbrellaTargetDescription
# @return [Xcodeproj::Project] The user project into which this target
# is integrated.
#
attr_accessor :user_project attr_accessor :user_project
# @return [String] The path of the user project # @return [String] The path of the user project
......
...@@ -54,6 +54,9 @@ module Pod ...@@ -54,6 +54,9 @@ module Pod
# #
attr_accessor :client_root attr_accessor :client_root
# @return [Xcodeproj::Project] the user project that this target will
# integrate as identified by the analyzer.
#
attr_accessor :user_project attr_accessor :user_project
# @return [Pathname] the path of the user project that this target will # @return [Pathname] the path of the user project that this target will
...@@ -73,9 +76,6 @@ module Pod ...@@ -73,9 +76,6 @@ module Pod
# List all user targets that will be integrated by this #target. # List all user targets that will be integrated by this #target.
# #
# @param [Xcodeproj::Project] project
# The project to search for the user targets
#
# @return [Array<PBXNativeTarget>] # @return [Array<PBXNativeTarget>]
# #
def user_targets def user_targets
......
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