xcodeproj 0.4.0 → 0.4.1

data/lib/xcodeproj/project/object/reference_proxy.rb

@@ -9,6 +9,8 @@ module Xcodeproj
       #
       class PBXReferenceProxy < AbstractObject
 
+        # @!group Attributes
+
         # @return [String] the path of the referenced filed.
         #
         attribute :path, String
@@ -18,21 +20,22 @@ module Xcodeproj
         attribute :file_type, String
 
         # @return [PBXContainerItemProxy] the proxy to the project that
-        #   contains the object.
+        #         contains the object.
         #
         has_one :remote_ref, PBXContainerItemProxy
 
-        # @return [String] the source tree for the path of the reference.
+        # @return   [String] the source tree for the path of the reference.
         #
-        # E.g. "BUILT_PRODUCTS_DIR"
+        # @example  Possible value
+        #           "BUILT_PRODUCTS_DIR"
         #
         attribute :source_tree, String
 
-        ## CONVENIENCE METHODS #################################################
+        #---------------------------------------------------------------------#
 
-        # @!group Convenience methods
+        # @!group Helpers
 
-        # Checks wheter the reference is a proxy.
+        # Checks whether the reference is a proxy.
         #
         # @return [Bool] always true for this ISA.
         #

data/lib/xcodeproj/project/object/root_object.rb

@@ -6,13 +6,15 @@ module Xcodeproj
       #
       class PBXProject < AbstractObject
 
+        # @!group Attributes
+
         # @return [ObjectList<PBXNativeTarget>] a list of all the targets in
-        #   the project.
+        #         the project.
         #
         has_many :targets, AbstractTarget
 
         # @return [Hash{String => String}] attributes the attributes of the
-        #   target.
+        #         target.
         #
         #   The hash might contain the following keys:
         #
@@ -43,12 +45,12 @@ module Xcodeproj
         attribute :known_regions, Array, ['en']
 
         # @return [PBXGroup] the main group of the project. The one displayed
-        #   by Xcode in the Project Navigator.
+        #         by Xcode in the Project Navigator.
         #
         has_one :main_group, PBXGroup
 
         # @return [PBXGroup] the group containing the references to products of
-        #   the project.
+        #         the project.
         #
         has_one :product_ref_group, PBXGroup
 

data/lib/xcodeproj/project/object/target_dependency.rb

@@ -6,23 +6,25 @@ module Xcodeproj
       #
       class PBXTargetDependency < AbstractObject
 
+        # @!group Attributes
+
         # @return [PBXNativeTarget] the target that needs to be built to
-        #   satisfy the dependency.
+        #         satisfy the dependency.
         #
         has_one :target, AbstractTarget
 
         # @return [PBXContainerItemProxy] a proxy for the target that needs to
-        #   be built.
+        #         be built.
         #
-        #   Apparently to support targets in other projects of the same
-        #   workspace.
+        # @note   Apparently to support targets in other projects of the same
+        #         workspace.
         #
         has_one :targetProxy, PBXContainerItemProxy
 
         # @return [String] the name of the target.
         #
-        #   This seems only to be used when the target dependency is a target
-        #   from a nested Xcode project.
+        # @note   This seems only to be used when the target dependency is a
+        #         target from a nested Xcode project.
         #
         attribute :name, String
       end

data/lib/xcodeproj/project/object_attributes.rb

@@ -34,14 +34,14 @@ module Xcodeproj
         # Attributes are expected to be instantiated only by the
         # {AbstractObject} DSL methods.
         #
-        # @param [Symbol] type
-        # the type of the attribute.
+        # @param  [Symbol] type
+        #         the type of the attribute.
         #
-        # @param [Symbol] name
-        #   the name of the attribute.
+        # @param  [Symbol] name
+        #         the name of the attribute.
         #
-        # @param [Class] owner
-        #   the class that owns the attribute.
+        # @param  [Class] owner
+        #         the class that owns the attribute.
         #
         def initialize(type, name, owner)
           @type  =  type
@@ -160,10 +160,11 @@ module Xcodeproj
         # - `{AbstractObject.has_one}`
         # - `{AbstractObject.has_many}`
         #
-        # The subclasses should not interfere with the methods synthesised by
-        # the DSL and should only implement convenience methods in top of them.
+        # @note The subclasses should not interfere with the methods
+        #       synthesised by the DSL and should only implement helpers in top
+        #       of them.
         #
-        # Attributes are typed and are validated at runtime.
+        # @note Attributes are typed and are validated at runtime.
         #
         class << self
 
@@ -175,6 +176,8 @@ module Xcodeproj
           #   an attribute of the superclass but for the method implementation
           #   they will duplicate them.
           #
+          # @visibility private
+          #
           def attributes
             unless @full_attributes
               attributes = @attributes || []
@@ -189,6 +192,8 @@ module Xcodeproj
           # @return [Array<AbstractObjectAttribute>] the simple attributes
           #   associated with with the class.
           #
+          # @visibility private
+          #
           def simple_attributes
             @simple_attributes ||= attributes.select { |a| a.type == :simple }
           end
@@ -197,6 +202,8 @@ module Xcodeproj
           #   representing a to one relationship associated with with the
           #   class.
           #
+          # @visibility private
+          #
           def to_one_attributes
             @to_one_attributes ||= attributes.select { |a| a.type == :to_one }
           end
@@ -205,10 +212,14 @@ module Xcodeproj
           #   representing a to many relationship associated with with the
           #   class.
           #
+          # @visibility private
+          #
           def to_many_attributes
             @to_many_attributes ||= attributes.select { |a| a.type == :to_many }
           end
 
+          # @visibility private
+          #
           def references_by_keys_attributes
             @references_by_keys_attributes ||= attributes.select { |a| a.type == :references_by_keys }
           end
@@ -352,7 +363,7 @@ module Xcodeproj
           # @param [String] plural_name
           #   the name of the relationship.
           #
-          # @param [Class, Array<Class>] isas
+          # @param [Class, Array<Class>] isas_hash
           #   the list of the classes corresponding to the accepted isas for
           #   this relationship.
           #
@@ -392,38 +403,52 @@ module Xcodeproj
           end
         end # AbstractObject << self
 
+        private
+
         # @return [Hash] the simple attributes hash.
         #
         attr_reader :simple_attributes_hash
 
+        public
+
         # @!group xcodeproj format attributes
 
         # @return (see AbstractObject.attributes)
         #
+        # @visibility private
+        #
         def attributes
           self.class.attributes
         end
 
         # @return (see AbstractObject.simple_attributes)
         #
+        # @visibility private
+        #
         def simple_attributes
           self.class.simple_attributes
         end
 
         # @return (see AbstractObject.to_one_attributes)
         #
+        # @visibility private
+        #
         def to_one_attributes
           self.class.to_one_attributes
         end
 
         # @return (see AbstractObject.to_many_attributes)
         #
+        # @visibility private
+        #
         def to_many_attributes
           self.class.to_many_attributes
         end
 
         # @return (see AbstractObject.to_many_attributes)
         #
+        # @visibility private
+        #
         def references_by_keys_attributes
           self.class.references_by_keys_attributes
         end

data/lib/xcodeproj/project/object_dictionary.rb

@@ -101,9 +101,9 @@ module Xcodeproj
 
       #------------------------------------------------------------------------#
 
-      # @!group Integration with {AbstractObject}
+      # @!group AbstractObject
 
-      # The plist reppresentation of the dictionary where the objects are
+      # The plist representation of the dictionary where the objects are
       # replaced by their UUIDs.
       #
       # @return [Hash<String => String>]
@@ -114,7 +114,7 @@ module Xcodeproj
         result
       end
 
-      # Returns a cascade reppresentation of the object without UUIDs.
+      # Returns a cascade representation of the object without UUIDs.
       #
       # @return [Hash<String => String>]
       #
@@ -134,7 +134,7 @@ module Xcodeproj
 
       #------------------------------------------------------------------------#
 
-      # @!group Integration with {ObjectList}
+      # @!group ObjectList
 
       # Informs the objects contained in the dictionary that another object is
       # referencing them.

data/lib/xcodeproj/project/object_list.rb

@@ -36,7 +36,7 @@ module Xcodeproj
 
       #------------------------------------------------------------------------#
 
-      # @!group Integration with {ObjectList}
+      # @!group ObjectList
 
       # @return [Array<String>]
       #   the UUIDs of all the objects referenced by this list.
@@ -60,7 +60,7 @@ module Xcodeproj
 
       # Adds an array of objects to list and updates their references count.
       #
-      # @param [Array<AbstractObject, ObjectDictionary>] object
+      # @param [Array<AbstractObject, ObjectDictionary>] objects
       #   an array of objects to add to the list.
       #
       # @return [void]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcodeproj
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-22 00:00:00.000000000 Z
+date: 2013-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -60,7 +60,6 @@ files:
 - lib/xcodeproj/config.rb
 - lib/xcodeproj/constants.rb
 - lib/xcodeproj/helper.rb
-- lib/xcodeproj/project/object/aggregate_target.rb
 - lib/xcodeproj/project/object/build_configuration.rb
 - lib/xcodeproj/project/object/build_file.rb
 - lib/xcodeproj/project/object/build_phase.rb
@@ -100,9 +99,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2142726412192456048
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -111,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Create and modify Xcode projects from Ruby.