Commit 4ccd4dc3 authored by Marius Rackwitz's avatar Marius Rackwitz

[Doc] Add initializer method descriptions

parent 80c0723e
...@@ -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}
# #
......
...@@ -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}
# #
......
...@@ -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)
......
...@@ -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
......
...@@ -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
# #
......
...@@ -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
# #
......
...@@ -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)
......
...@@ -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)
......
...@@ -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
# #
......
...@@ -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
# #
......
...@@ -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
......
...@@ -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
# #
......
...@@ -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)
......
...@@ -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)
......
...@@ -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
# #
......
...@@ -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}.
......
...@@ -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
......
...@@ -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`).
......
...@@ -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
......
...@@ -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
......
...@@ -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
# #
......
...@@ -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.
# #
......
...@@ -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
......
...@@ -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)
......
...@@ -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.
......
...@@ -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
......
...@@ -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)
......
...@@ -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
# #
......
...@@ -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)
......
...@@ -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
# #
......
...@@ -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.
# #
......
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