Merge pull request #7482 from CocoaPods/seg-fix-inch

Fix documentation

lib/cocoapods/installer/analyzer/podfile_dependency_cache.rb

@@ -30,6 +30,12 @@ module Pod
 
         # Creates a {PodfileDependencyCache} from the given {Podfile}
         #
+        # @param [Podfile] podfile
+        #        The {Podfile} from which dependencies should be cached
+        #
+        # @return [PodfileDependencyCache]
+        #         A warmed, immutable cache of all the dependencies in the {Podfile}
+        #
         def self.from_podfile(podfile)
           podfile_dependencies = []
           dependencies_by_target_definition = {}

lib/cocoapods/installer/podfile_validator.rb

@@ -17,9 +17,13 @@ module Pod
       attr_reader :warnings
 
       # Initialize a new instance
+      #
       # @param [Podfile] podfile
       #        The podfile to validate
       #
+      # @param [Analyzer::PodfileDependencyCache] podfile_dependency_cache
+      #        An (optional) cache of all the dependencies in the podfile
+      #
       def initialize(podfile, podfile_dependency_cache = Analyzer::PodfileDependencyCache.from_podfile(podfile))
         @podfile = podfile
         @podfile_dependency_cache = podfile_dependency_cache

lib/cocoapods/project.rb

@@ -40,8 +40,16 @@ module Pod
     #
     attr_reader :development_pods
 
-    # Overridden to generate UUIDs in a much faster way, since we don't need to check for collisions
-    # (as the Pods project is regenerated each time, and thus all UUIDs will have come from this method)
+    # Generates a list of new UUIDs that created objects can be assigned.
+    #
+    # @note Overridden to generate UUIDs in a much faster way, since we don't need to check for collisions
+    #       (as the Pods project is regenerated each time, and thus all UUIDs will have come from this method)
+    #
+    # @param [Integer] count
+    #        The number of UUIDs to generate
+    #
+    # @return [Void]
+    #
     def generate_available_uuid_list(count = 100)
       start = @generated_uuids.size
       uniques = Array.new(count) { |i| format('%011X0', start + i) }