[Docs] Fixed yard warnings.

lib/cocoapods/command/advanced_linter.rb

@@ -201,7 +201,7 @@ module Pod
         end
       end
 
-      # @errors   += (@platform_errors[platform] - @errors).map {|m| "[#{platform}] #{m}"}
+      # @ errors   += (@platform_errors[platform] - @errors).map {|m| "[#{platform}] #{m}"}
 
       #-----------------------------------------------------------------------#
 

lib/cocoapods/downloader/git.rb

@@ -115,7 +115,7 @@ module Pod
       # @return [void] Checks if a reference exists in the cache and updates
       # only if necessary.
       #
-      # @raises if after the update the reference can't be found.
+      # @raise If after the update the reference can't be found.
       #
       def ensure_ref_exists(ref)
         return if ref_exists?(ref)
@@ -133,7 +133,7 @@ module Pod
       # @return [void] Checks if a branch exists in the cache and updates
       # only if necessary.
       #
-      # @raises if after the update the branch can't be found.
+      # @raise If after the update the branch can't be found.
       #
       def ensure_remote_branch_exists(branch)
         return if branch_exists?(branch)

lib/cocoapods/generator/prefix_header.rb

@@ -19,9 +19,8 @@ module Pod
       #
       attr_reader :pods
 
-      # @param  [Platform] platform @see platform
-      #
-      # @param  [Array<LocalPod>]   @see pods
+      # @param  [Platform] platform     @see platform
+      # @param  [Array<LocalPod>] pods  @see pods
       #
       def initialize(platform, pods)
         @platform = platform

lib/cocoapods/generator/xcconfig.rb

@@ -19,9 +19,9 @@ module Pod
       #
       attr_reader :relative_pods_root
 
-      # @param  [Platform] platform @see platform
-      #
-      # @param  [Array<LocalPod>]   @see pods
+      # @param  [Sandbox] sandbox @see sandbox
+      # @param  [Array<LocalPod>] pods @see pods
+      # @param  [String] relative_pods_root @see relative_pods_root
       #
       def initialize(sandbox, pods, relative_pods_root)
         @sandbox = sandbox

lib/cocoapods/installer.rb

@@ -72,7 +72,6 @@ module Pod
     # @param [Sandbox]  sandbox     @see sandbox
     # @param [Podfile]  podfile     @see podfile
     # @param [Lockfile] lockfile    @see lockfile
-    # @param [Bool]     update_mode @see update_mode
     #
     def initialize(sandbox, podfile, lockfile = nil)
       @sandbox     =  sandbox

lib/cocoapods/local_pod.rb

@@ -502,15 +502,17 @@ module Pod
       root.relative_path_from(@sandbox.root)
     end
 
-    # @return Hash{Pathname => [Array<Pathname>]} A hash containing the headers
-    #   folders as the keys and the absolute paths of the header files
-    #   as the values.
+    # @return [Hash{Pathname => Array<Pathname>}] A hash containing the headers
+    #         folders as the keys and the absolute paths of the header files as
+    #         the values.
     #
-    # @todo this is being overridden in the RestKit 0.9.4 spec, need to do
-    # something with that, and this method also still exists in Specification.
+    # @todo   This is being overridden in the RestKit 0.9.4 spec, need to do
+    #         something with that, and this method also still exists in
+    #         Specification.
+    #
+    # @todo   This is not overridden anymore in specification refactor and the
+    #         code Pod::Specification#copy_header_mapping can be moved here.
     #
-    # @todo This is not overridden anymore in specification refactor and the
-    #   code Pod::Specification#copy_header_mapping can be moved here.
     def header_mappings(files_by_spec)
       mappings = {}
       files_by_spec.each do |spec, paths|
@@ -525,7 +527,7 @@ module Pod
       mappings
     end
 
-    # @return <Pathname> The name of the folder where the headers of this pod
+    # @return [<Pathname>] The name of the folder where the headers of this pod
     #   will be namespaced.
     #
     def headers_sandbox
@@ -549,7 +551,12 @@ module Pod
     #
     # @param [Symbol] accessor The accessor to use to obtain the paths patterns.
     #
-    # @param [Hash] options (see #expanded_paths)
+    # @param  [String] dir_pattern
+    #         The pattern to add to directories.
+    #
+    # @param  [Array<Specification>] specs
+    #         The specification of which the patterns are needed.
+    #         If not specifies it defaults {#specifications}.
     #
     def paths_by_spec(accessor, dir_pattern = nil, specs = nil)
       specs ||= specifications
@@ -568,18 +575,20 @@ module Pod
     end
 
     # Converts patterns of paths to the {Pathname} of the files present in the
-    #   pod.
+    # pod.
     #
     # @param [String, FileList, Array<String, Pathname>] patterns
-    #   The patterns to expand.
-    # @param [Hash] options
-    #   The options to used for expanding the paths patterns.
-    # @option options [String] :glob
-    #   The pattern to use for globing directories.
+    #         The patterns to expand.
+    #
+    # @param  [String] dir_pattern
+    #         The pattern to add to directories.
+    #
+    # @param  [String] exclude_patterns
+    #         The exclude patterns to pass to the PathList.
     #
-    # @raise [Informative] If the pod does not exists.
+    # @raise  [Informative] If the pod does not exists.
     #
-    # @todo implement case insensitive search
+    # @todo   Implement case insensitive search
     #
     # @return [Array<Pathname>] A list of the paths.
     #

lib/cocoapods/project.rb

@@ -85,7 +85,7 @@ module Pod
 
     # Adds a file reference to the podfile.
     #
-    # @param  [#to_s] path
+    # @param  [#to_s] podfile_path
     #         the path of the podfile
     #
     # @return [PBXFileReference]
@@ -202,7 +202,6 @@ module Pod
 
       # @param  [TargetDefinition]  target_definition @see target_definition
       # @param  [PBXNativeTarget]   target            @see target
-      # @param  [Project]           project           @see project
       #
       def initialize(target_definition, target)
         @target_definition = target_definition
@@ -227,9 +226,9 @@ module Pod
       # Returns the path of the user project that the {TargetDefinition}
       # should integrate.
       #
-      # @raises If the project is implicit and there are multiple projects.
+      # @raise If the project is implicit and there are multiple projects.
       #
-      # @raises If the path doesn't exits.
+      # @raise If the path doesn't exits.
       #
       # @return [Pathname] the path of the user project.
       #

lib/cocoapods/resolver.rb

@@ -197,20 +197,15 @@ module Pod
     #
     # @param  [Dependency] dependency
     #         the dependency for which the set is needed.
-    #         TODO: check dependency.specification
-    #
-    # @param [Platform] platform
-    #         the platform on which the dependency is needed this is used by
-    #         the sandbox to locate external sources.
-    #         TODO why?
     #
     # @note   If the {#update_external_specs} flag is activated the
     #         dependencies with external sources are always resolved against
     #         the remote. Otherwise the specification is retrieved from the
     #         sandbox that fetches the external source only if needed.
     #
-    # TODO    If the set is loaded from a normal source and then from an
+    # @todo   If the set is loaded from a normal source and then from an
     #         external one that information is lost.
+    # @todo   Check dependency.specification
     #
     # @return [Set] the cached set for a given dependency.
     #
@@ -244,7 +239,7 @@ module Pod
 
     # Ensures that a spec is compatible with the platform of a target.
     #
-    # @raises If the spec is not supported by the target.
+    # @raise If the spec is not supported by the target.
     #
     # @return [void]
     #

lib/cocoapods/source.rb

@@ -45,7 +45,7 @@ module Pod
       #         should include also the author, the summary, and the
       #         description.
       #
-      # @raises If no source including the set can be found.
+      # @raise  If no source including the set can be found.
       #
       # @note   Full text search requires to load the specification for each
       #         pod, hence is considerably slower.
@@ -54,8 +54,8 @@ module Pod
       #
       # @return [Array<Set>]  The sets that contain the search term.
       #
-      def search_by_name(name, full_text_search = false)
-        result = Aggregate.new(config.repos_dir).search_by_name(name, full_text_search)
+      def search_by_name(query, full_text_search = false)
+        result = Aggregate.new(config.repos_dir).search_by_name(query, full_text_search)
         if result.empty?
           extra = ", author, summary, or description" if full_text_search
           raise Informative "Unable to find a pod with name#{extra} matching `#{query}'"