Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
C
cocoapods
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
gengmeiios
cocoapods
Commits
4ccd4dc3
Commit
4ccd4dc3
authored
Sep 14, 2014
by
Marius Rackwitz
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
[Doc] Add initializer method descriptions
parent
80c0723e
Hide whitespace changes
Inline
Side-by-side
Showing
31 changed files
with
64 additions
and
0 deletions
+64
-0
cache.rb
lib/cocoapods/downloader/cache.rb
+2
-0
request.rb
lib/cocoapods/downloader/request.rb
+2
-0
executable.rb
lib/cocoapods/executable.rb
+2
-0
abstract_external_source.rb
lib/cocoapods/external_sources/abstract_external_source.rb
+2
-0
copy_resources_script.rb
lib/cocoapods/generator/copy_resources_script.rb
+2
-0
header.rb
lib/cocoapods/generator/header.rb
+2
-0
info_plist_file.rb
lib/cocoapods/generator/info_plist_file.rb
+2
-0
module_map.rb
lib/cocoapods/generator/module_map.rb
+2
-0
prefix_header.rb
lib/cocoapods/generator/prefix_header.rb
+2
-0
umbrella_header.rb
lib/cocoapods/generator/umbrella_header.rb
+2
-0
aggregate_xcconfig.rb
lib/cocoapods/generator/xcconfig/aggregate_xcconfig.rb
+2
-0
private_pod_xcconfig.rb
lib/cocoapods/generator/xcconfig/private_pod_xcconfig.rb
+2
-0
public_pod_xcconfig.rb
lib/cocoapods/generator/xcconfig/public_pod_xcconfig.rb
+2
-0
installer_representation.rb
lib/cocoapods/hooks/installer_representation.rb
+2
-0
library_representation.rb
lib/cocoapods/hooks/library_representation.rb
+2
-0
hooks_manager.rb
lib/cocoapods/hooks_manager.rb
+2
-0
installer.rb
lib/cocoapods/installer.rb
+2
-0
analyzer.rb
lib/cocoapods/installer/analyzer.rb
+4
-0
sandbox_analyzer.rb
lib/cocoapods/installer/analyzer/sandbox_analyzer.rb
+2
-0
file_references_installer.rb
lib/cocoapods/installer/file_references_installer.rb
+2
-0
pod_source_installer.rb
lib/cocoapods/installer/pod_source_installer.rb
+2
-0
pod_source_preparer.rb
lib/cocoapods/installer/pod_source_preparer.rb
+2
-0
user_project_integrator.rb
lib/cocoapods/installer/user_project_integrator.rb
+2
-0
target_integrator.rb
...ds/installer/user_project_integrator/target_integrator.rb
+2
-0
project.rb
lib/cocoapods/project.rb
+2
-0
resolver.rb
lib/cocoapods/resolver.rb
+2
-0
sandbox.rb
lib/cocoapods/sandbox.rb
+2
-0
file_accessor.rb
lib/cocoapods/sandbox/file_accessor.rb
+2
-0
path_list.rb
lib/cocoapods/sandbox/path_list.rb
+2
-0
aggregate_target.rb
lib/cocoapods/target/aggregate_target.rb
+2
-0
validator.rb
lib/cocoapods/validator.rb
+2
-0
No files found.
lib/cocoapods/downloader/cache.rb
View file @
4ccd4dc3
...
@@ -12,6 +12,8 @@ module Pod
...
@@ -12,6 +12,8 @@ module Pod
#
#
attr_reader
:root
attr_reader
:root
# Initialize a new instance
#
# @param [Pathname,String] root
# @param [Pathname,String] root
# see {#root}
# see {#root}
#
#
...
...
lib/cocoapods/downloader/request.rb
View file @
4ccd4dc3
...
@@ -28,6 +28,8 @@ module Pod
...
@@ -28,6 +28,8 @@ module Pod
attr_reader
:head
attr_reader
:head
alias_method
:head?
,
:head
alias_method
:head?
,
:head
# Initialize a new instance
#
# @param [Specification,Nil] spec
# @param [Specification,Nil] spec
# see {#spec}
# see {#spec}
#
#
...
...
lib/cocoapods/executable.rb
View file @
4ccd4dc3
...
@@ -101,6 +101,8 @@ module Pod
...
@@ -101,6 +101,8 @@ module Pod
#
#
attr_accessor
:io
attr_accessor
:io
# Init a new Indenter
#
# @param [IO] io @see io
# @param [IO] io @see io
#
#
def
initialize
(
io
=
nil
)
def
initialize
(
io
=
nil
)
...
...
lib/cocoapods/external_sources/abstract_external_source.rb
View file @
4ccd4dc3
...
@@ -17,6 +17,8 @@ module Pod
...
@@ -17,6 +17,8 @@ module Pod
#
#
attr_reader
:podfile_path
attr_reader
:podfile_path
# Initialize a new instance
#
# @param [String] name @see name
# @param [String] name @see name
# @param [Hash] params @see params
# @param [Hash] params @see params
# @param [String] podfile_path @see podfile_path
# @param [String] podfile_path @see podfile_path
...
...
lib/cocoapods/generator/copy_resources_script.rb
View file @
4ccd4dc3
...
@@ -13,6 +13,8 @@ module Pod
...
@@ -13,6 +13,8 @@ module Pod
#
#
attr_reader
:platform
attr_reader
:platform
# Initialize a new instance
#
# @param [Hash<String, Array<String>>] resources_by_config
# @param [Hash<String, Array<String>>] resources_by_config
# @see resources_by_config
# @see resources_by_config
#
#
...
...
lib/cocoapods/generator/header.rb
View file @
4ccd4dc3
...
@@ -19,6 +19,8 @@ module Pod
...
@@ -19,6 +19,8 @@ module Pod
#
#
attr_accessor
:module_imports
attr_accessor
:module_imports
# Initialize a new instance
#
# @param [Symbol] platform
# @param [Symbol] platform
# @see platform
# @see platform
#
#
...
...
lib/cocoapods/generator/info_plist_file.rb
View file @
4ccd4dc3
...
@@ -9,6 +9,8 @@ module Pod
...
@@ -9,6 +9,8 @@ module Pod
#
#
attr_reader
:target
attr_reader
:target
# Initialize a new instance
#
# @param [Target] target @see target
# @param [Target] target @see target
#
#
def
initialize
(
target
)
def
initialize
(
target
)
...
...
lib/cocoapods/generator/module_map.rb
View file @
4ccd4dc3
...
@@ -14,6 +14,8 @@ module Pod
...
@@ -14,6 +14,8 @@ module Pod
#
#
attr_accessor
:private_headers
attr_accessor
:private_headers
# Initialize a new instance
#
# @param [Target] target @see target
# @param [Target] target @see target
#
#
def
initialize
(
target
)
def
initialize
(
target
)
...
...
lib/cocoapods/generator/prefix_header.rb
View file @
4ccd4dc3
...
@@ -12,6 +12,8 @@ module Pod
...
@@ -12,6 +12,8 @@ module Pod
#
#
attr_reader
:file_accessors
attr_reader
:file_accessors
# Initialize a new instance
#
# @param [Array<FileAccessor>] file_accessors
# @param [Array<FileAccessor>] file_accessors
# @see file_accessors
# @see file_accessors
#
#
...
...
lib/cocoapods/generator/umbrella_header.rb
View file @
4ccd4dc3
...
@@ -12,6 +12,8 @@ module Pod
...
@@ -12,6 +12,8 @@ module Pod
# the target, which provides the product name
# the target, which provides the product name
attr_reader
:target
attr_reader
:target
# Initialize a new instance
#
# @param [Target] target
# @param [Target] target
# @see target
# @see target
#
#
...
...
lib/cocoapods/generator/xcconfig/aggregate_xcconfig.rb
View file @
4ccd4dc3
...
@@ -8,6 +8,8 @@ module Pod
...
@@ -8,6 +8,8 @@ module Pod
#
#
attr_reader
:target
attr_reader
:target
# Initialize a new instance
#
# @param [Target] target @see target
# @param [Target] target @see target
#
#
# @param [String] configuration_name
# @param [String] configuration_name
...
...
lib/cocoapods/generator/xcconfig/private_pod_xcconfig.rb
View file @
4ccd4dc3
...
@@ -17,6 +17,8 @@ module Pod
...
@@ -17,6 +17,8 @@ module Pod
#
#
attr_reader
:public_xcconfig
attr_reader
:public_xcconfig
# Initialize a new instance
#
# @param [Target] target @see target
# @param [Target] target @see target
# @param [Xcodeproj::Config] public_xcconfig @see public_xcconfig
# @param [Xcodeproj::Config] public_xcconfig @see public_xcconfig
#
#
...
...
lib/cocoapods/generator/xcconfig/public_pod_xcconfig.rb
View file @
4ccd4dc3
...
@@ -13,6 +13,8 @@ module Pod
...
@@ -13,6 +13,8 @@ module Pod
#
#
attr_reader
:target
attr_reader
:target
# Initialize a new instance
#
# @param [Target] target @see target
# @param [Target] target @see target
#
#
def
initialize
(
target
)
def
initialize
(
target
)
...
...
lib/cocoapods/hooks/installer_representation.rb
View file @
4ccd4dc3
...
@@ -119,6 +119,8 @@ module Pod
...
@@ -119,6 +119,8 @@ module Pod
# @!group Private implementation
# @!group Private implementation
# Initialize a new instance
#
# @param [Installer] installer @see installer
# @param [Installer] installer @see installer
#
#
def
initialize
(
installer
)
def
initialize
(
installer
)
...
...
lib/cocoapods/hooks/library_representation.rb
View file @
4ccd4dc3
...
@@ -76,6 +76,8 @@ module Pod
...
@@ -76,6 +76,8 @@ module Pod
# @!group Private implementation
# @!group Private implementation
# Initialize a new instance
#
# @param [Sandbox] sandbox @see sandbox
# @param [Sandbox] sandbox @see sandbox
# @param [Target] library @see library
# @param [Target] library @see library
#
#
...
...
lib/cocoapods/hooks_manager.rb
View file @
4ccd4dc3
...
@@ -34,6 +34,8 @@ module Pod
...
@@ -34,6 +34,8 @@ module Pod
#
#
attr_reader
:block
attr_reader
:block
# Initialize a new instance
#
# @param [String] name @see {#name}.
# @param [String] name @see {#name}.
#
#
# @param [String] plugin_name @see {#plugin_name}.
# @param [String] plugin_name @see {#plugin_name}.
...
...
lib/cocoapods/installer.rb
View file @
4ccd4dc3
...
@@ -55,6 +55,8 @@ module Pod
...
@@ -55,6 +55,8 @@ module Pod
#
#
attr_reader
:lockfile
attr_reader
:lockfile
# Initialize a new instance
#
# @param [Sandbox] sandbox @see sandbox
# @param [Sandbox] sandbox @see sandbox
# @param [Podfile] podfile @see podfile
# @param [Podfile] podfile @see podfile
# @param [Lockfile] lockfile @see lockfile
# @param [Lockfile] lockfile @see lockfile
...
...
lib/cocoapods/installer/analyzer.rb
View file @
4ccd4dc3
...
@@ -24,6 +24,8 @@ module Pod
...
@@ -24,6 +24,8 @@ module Pod
#
#
attr_reader
:lockfile
attr_reader
:lockfile
# Initialize a new instance
#
# @param [Sandbox] sandbox @see sandbox
# @param [Sandbox] sandbox @see sandbox
# @param [Podfile] podfile @see podfile
# @param [Podfile] podfile @see podfile
# @param [Lockfile] lockfile @see lockfile
# @param [Lockfile] lockfile @see lockfile
...
@@ -766,6 +768,8 @@ module Pod
...
@@ -766,6 +768,8 @@ module Pod
# subspecs are added instead of the name of the Pods.
# subspecs are added instead of the name of the Pods.
#
#
class
SpecsState
class
SpecsState
# Initialize a new instance
#
# @param [Hash{Symbol=>String}] pods_by_state
# @param [Hash{Symbol=>String}] pods_by_state
# The name of the pods grouped by their state
# The name of the pods grouped by their state
# (`:added`, `:removed`, `:changed` or `:unchanged`).
# (`:added`, `:removed`, `:changed` or `:unchanged`).
...
...
lib/cocoapods/installer/analyzer/sandbox_analyzer.rb
View file @
4ccd4dc3
...
@@ -51,6 +51,8 @@ module Pod
...
@@ -51,6 +51,8 @@ module Pod
#
#
attr_reader
:lockfile
attr_reader
:lockfile
# Init a new SandboxAnalyzer
#
# @param [Sandbox] sandbox @see sandbox
# @param [Sandbox] sandbox @see sandbox
# @param [Array<Specifications>] specs @see specs
# @param [Array<Specifications>] specs @see specs
# @param [Bool] update_mode @see update_mode
# @param [Bool] update_mode @see update_mode
...
...
lib/cocoapods/installer/file_references_installer.rb
View file @
4ccd4dc3
...
@@ -16,6 +16,8 @@ module Pod
...
@@ -16,6 +16,8 @@ module Pod
#
#
attr_reader
:pods_project
attr_reader
:pods_project
# Initialize a new instance
#
# @param [Sandbox] sandbox @see sandbox
# @param [Sandbox] sandbox @see sandbox
# @param [Array<PodTarget>] libraries @see libraries
# @param [Array<PodTarget>] libraries @see libraries
# @param [Project] libraries @see libraries
# @param [Project] libraries @see libraries
...
...
lib/cocoapods/installer/pod_source_installer.rb
View file @
4ccd4dc3
...
@@ -17,6 +17,8 @@ module Pod
...
@@ -17,6 +17,8 @@ module Pod
#
#
attr_reader
:specs_by_platform
attr_reader
:specs_by_platform
# Initialize a new instance
#
# @param [Sandbox] sandbox @see sandbox
# @param [Sandbox] sandbox @see sandbox
# @param [Hash{Symbol=>Array}] specs_by_platform @see specs_by_platform
# @param [Hash{Symbol=>Array}] specs_by_platform @see specs_by_platform
#
#
...
...
lib/cocoapods/installer/pod_source_preparer.rb
View file @
4ccd4dc3
...
@@ -12,6 +12,8 @@ module Pod
...
@@ -12,6 +12,8 @@ module Pod
#
#
attr_reader
:path
attr_reader
:path
# Initialize a new instance
#
# @param [Specification] spec the root specification of the Pod.
# @param [Specification] spec the root specification of the Pod.
# @param [Pathname] path the folder where the source of the Pod is located.
# @param [Pathname] path the folder where the source of the Pod is located.
#
#
...
...
lib/cocoapods/installer/user_project_integrator.rb
View file @
4ccd4dc3
...
@@ -37,6 +37,8 @@ module Pod
...
@@ -37,6 +37,8 @@ module Pod
#
#
attr_reader
:targets
attr_reader
:targets
# Init a new UserProjectIntegrator
#
# @param [Podfile] podfile @see #podfile
# @param [Podfile] podfile @see #podfile
# @param [Sandbox] sandbox @see #sandbox
# @param [Sandbox] sandbox @see #sandbox
# @param [Pathname] installation_root @see #installation_root
# @param [Pathname] installation_root @see #installation_root
...
...
lib/cocoapods/installer/user_project_integrator/target_integrator.rb
View file @
4ccd4dc3
...
@@ -18,6 +18,8 @@ module Pod
...
@@ -18,6 +18,8 @@ module Pod
#
#
attr_reader
:target
attr_reader
:target
# Init a new TargetIntegrator
#
# @param [Target] target @see #target_definition
# @param [Target] target @see #target_definition
#
#
def
initialize
(
target
)
def
initialize
(
target
)
...
...
lib/cocoapods/project.rb
View file @
4ccd4dc3
...
@@ -7,6 +7,8 @@ module Pod
...
@@ -7,6 +7,8 @@ module Pod
# through the installation process.
# through the installation process.
#
#
class
Project
<
Xcodeproj
::
Project
class
Project
<
Xcodeproj
::
Project
# Initialize a new instance
#
# @param [Pathname, String] path @see path
# @param [Pathname, String] path @see path
# @param [Bool] skip_initialization
# @param [Bool] skip_initialization
# Whether the project should be initialized from scratch.
# Whether the project should be initialized from scratch.
...
...
lib/cocoapods/resolver.rb
View file @
4ccd4dc3
...
@@ -25,6 +25,8 @@ module Pod
...
@@ -25,6 +25,8 @@ module Pod
#
#
attr_accessor
:sources
attr_accessor
:sources
# Init a new Resolver
#
# @param [Sandbox] sandbox @see sandbox
# @param [Sandbox] sandbox @see sandbox
# @param [Podfile] podfile @see podfile
# @param [Podfile] podfile @see podfile
# @param [Array<Dependency>] locked_dependencies @see locked_dependencies
# @param [Array<Dependency>] locked_dependencies @see locked_dependencies
...
...
lib/cocoapods/sandbox.rb
View file @
4ccd4dc3
...
@@ -50,6 +50,8 @@ module Pod
...
@@ -50,6 +50,8 @@ module Pod
#
#
attr_reader
:public_headers
attr_reader
:public_headers
# Initialize a new instance
#
# @param [String, Pathname] root @see root
# @param [String, Pathname] root @see root
#
#
def
initialize
(
root
)
def
initialize
(
root
)
...
...
lib/cocoapods/sandbox/file_accessor.rb
View file @
4ccd4dc3
...
@@ -27,6 +27,8 @@ module Pod
...
@@ -27,6 +27,8 @@ module Pod
#
#
attr_reader
:spec_consumer
attr_reader
:spec_consumer
# Initialize a new instance
#
# @param [Sandbox::PathList, Pathname] path_list @see path_list
# @param [Sandbox::PathList, Pathname] path_list @see path_list
# @param [Specification::Consumer] spec_consumer @see spec_consumer
# @param [Specification::Consumer] spec_consumer @see spec_consumer
#
#
...
...
lib/cocoapods/sandbox/path_list.rb
View file @
4ccd4dc3
...
@@ -15,6 +15,8 @@ module Pod
...
@@ -15,6 +15,8 @@ module Pod
#
#
attr_accessor
:root
attr_accessor
:root
# Initialize a new instance
#
# @param [Pathname] root The root of the PathList.
# @param [Pathname] root The root of the PathList.
#
#
def
initialize
(
root
)
def
initialize
(
root
)
...
...
lib/cocoapods/target/aggregate_target.rb
View file @
4ccd4dc3
...
@@ -3,6 +3,8 @@ module Pod
...
@@ -3,6 +3,8 @@ module Pod
# of the single Pods. The client targets will then depend on this one.
# of the single Pods. The client targets will then depend on this one.
#
#
class
AggregateTarget
<
Target
class
AggregateTarget
<
Target
# Initialize a new instance
#
# @param [TargetDefinition] target_definition @see target_definition
# @param [TargetDefinition] target_definition @see target_definition
# @param [Sandbox] sandbox @see sandbox
# @param [Sandbox] sandbox @see sandbox
#
#
...
...
lib/cocoapods/validator.rb
View file @
4ccd4dc3
...
@@ -16,6 +16,8 @@ module Pod
...
@@ -16,6 +16,8 @@ module Pod
#
#
attr_reader
:linter
attr_reader
:linter
# Initialize a new instance
#
# @param [Specification, Pathname, String] spec_or_path
# @param [Specification, Pathname, String] spec_or_path
# the Specification or the path of the `podspec` file to lint.
# the Specification or the path of the `podspec` file to lint.
#
#
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment