sketchup-api-stubs 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e767a530efec610dbe924a90a2132297bf68bef
-  data.tar.gz: 9124efa94bc161ab407921398a40f6f05b22c6f5
+  metadata.gz: 26637fb494dcc7f44b4445e237bbf28a252bfdf5
+  data.tar.gz: a67eeba59e499c9235d43efbcc465fe02e50f956
 SHA512:
-  metadata.gz: 63264aa870bb4c805b8bbf8eb3feff1cfa7388ec511e858694c0948d8910243a278a60818de5430367e1121ec8b67c8e41c4968815c7da37ab557ba559230c88
-  data.tar.gz: 45e6aca141709127131dd39233f92dae97c767d9315b9a5ebe6c9d928684b6d9bb18e2d15e9e9a49c931f87429b40d7fb79e81cc27202fdd968d68f7a3cd0b36
+  metadata.gz: 0ec84ecbee17a6d05970cb9f6a7f322a58ab6109fedd91cf6d2cdd68bd01f4133dd795f0ae1043add96f83022edbcd58f7ad487987a07d8df5d94e3bcb6d9b70
+  data.tar.gz: 878cd1af89b83c621221cee370737ff18ca5a3c24240434293f421fb65164bc43fdb42d2c788a47f43a4b9274ac47c189e1350fa672ab7022095a3450a2af9cd

data/SketchUp/Geom/LatLong.rb

@@ -66,37 +66,25 @@ class Geom::LatLong
   def longitude
   end
 
-  # The to_a method converts a LatLong object to an array of two values.
+  # The {#to_a} method converts a LatLong object to an array of two values.
   #
   # @example
-  #   ll = [40.01700, 105.28300]
-  #   latlong = Geom::LatLong.new(ll)
-  #   a = latlong.to_a
-  #   if (a)
-  #     UI.messagebox a
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   latlong = Geom::LatLong.new([40.01700, 105.28300])
+  #   array = latlong.to_a
   #
-  # @return array - an array of two values: latitude and longitude
+  # @return [Array(Float, Float)] an array of latitude and longitude
   #
   # @version SketchUp 6.0
   def to_a
   end
 
-  # The to_a method converts a LatLong object to a string.
+  # The {#to_s} method converts a LatLong object to a {String}.
   #
   # @example
-  #   ll = [40.01700, 105.28300]
-  #   latlong = Geom::LatLong.new(ll)
-  #   s = latlong.to_s
-  #   if (s)
-  #     UI.messagebox s
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   latlong = Geom::LatLong.new([40.01700, 105.28300])
+  #   string = latlong.to_s
   #
-  # @return string - a string representation of a LatLong object
+  # @return [String]
   #
   # @version SketchUp 6.0
   def to_s

data/SketchUp/Geom/Point3d.rb

@@ -329,8 +329,8 @@ class Geom::Point3d
   #
   # @example
   #   point1 = Geom::Point3d.new(10,10,10)
-  #   vector = Geom::Vector3d.new(0,0,1)
-  #   point2 = point1.offset! vector
+  #   vector = Geom::Vector3d.new(0, 0, 1)
+  #   point2 = point1.offset(vector)
   #
   # @param vector
   #   A Vector3d object to offset the point by.

data/SketchUp/Geom/Vector3d.rb

@@ -49,42 +49,44 @@ class Geom::Vector3d
 
   # Instance Methods
 
-  # The dot method is used to compute the dot product between two vectors.
+  # The {#%} method is used to compute the dot product between two vectors.
+  #
+  # This is an alias of the {#dot} method.
   #
   # @example
-  #   vector = Geom::Vector3d.new 0,0,1
-  #   vector2 = Geom::Vector3d.new 0,1,0
-  #   d = vector.dot vector2
+  #   vector1 = Geom::Vector3d.new(0, 0, 1)
+  #   vector2 = Geom::Vector3d.new(0, 1, 0)
+  #   dot = vector1 % vector2
   #
-  # @param vector2
-  #   A Vector3d object.
+  # @param [Geom::Vector] vector
+  #
+  # @return [Float]
   #
-  # @return d - the dot product of vector1 and vector2
+  # @see #dot
   #
   # @version SketchUp 6.0
-  def %(vector2)
+  def %(vector)
   end
 
-  # The cross method is used to compute the cross product between two vectors.
+  # The {#*} method is used to compute the cross product between two vectors.
   #
   # The cross product, also called the vector product, is an operation on two
   # vectors. The cross product of two vectors produces a third vector which is
   # perpendicular to the plane in which the first two lie.
   #
-  # @example
-  #   vector1 = Geom::Vector3d.new(1,0,0)
-  #   vector2 = Geom::Vector3d.new(0,1,0)
-  #   vector3 = vector1 * vector2
+  # This is an alias of the {#cross} method.
   #
   # @example
-  #   vector = Geom::Vector3d.new(1,0,0)
-  #   vector2 = Geom::Vector3d.new(0,1,0)
-  #   vector3 = vector.cross(vector2)
+  #   vector1 = Geom::Vector3d.new 1,0,0
+  #   vector2 = Geom::Vector3d.new 0,1,0
+  #   vector3 = vector1 * vector2
   #
   # @param vector
   #   A Vector3d object.
   #
-  # @return vector - the cross of vector1 and vector2
+  # @return vector - a Vector3d object if successful
+  #
+  # @see #cross
   #
   # @version SketchUp 6.0
   def *(vector)
@@ -251,7 +253,7 @@ class Geom::Vector3d
   def clone
   end
 
-  # The cross method is used to compute the cross product between two vectors.
+  # The {#cross} method is used to compute the cross product between two vectors.
   #
   # The cross product, also called the vector product, is an operation on two
   # vectors. The cross product of two vectors produces a third vector which is
@@ -272,24 +274,27 @@ class Geom::Vector3d
   #
   # @return vector - the cross of vector1 and vector2
   #
+  # @see #*
+  #
   # @version SketchUp 6.0
   def cross(vector)
   end
 
-  # The dot method is used to compute the dot product between two vectors.
+  # The {#dot} method is used to compute the dot product between two vectors.
   #
   # @example
-  #   vector = Geom::Vector3d.new 0,0,1
-  #   vector2 = Geom::Vector3d.new 0,1,0
-  #   d = vector.dot vector2
+  #   vector1 = Geom::Vector3d.new(0, 0, 1)
+  #   vector2 = Geom::Vector3d.new(0, 1, 0)
+  #   dot = vector1.dot(vector2)
   #
-  # @param vector2
-  #   A Vector3d object.
+  # @param [Geom::Vector] vector
+  #
+  # @return [Float]
   #
-  # @return d - the dot product of vector1 and vector2
+  # @see #%
   #
   # @version SketchUp 6.0
-  def dot(vector2)
+  def dot(vector)
   end
 
   # The new method is used to create a new vector.

data/SketchUp/Sketchup/AttributeDictionaries.rb

@@ -59,8 +59,7 @@ class Sketchup::AttributeDictionaries < Sketchup::Entity
   #   dictionaries = model.attribute_dictionaries
   #   number = dictionaries.count
   #
-  # @return [Integer] the number of attribute dictionary objects
-  #   in the collection.
+  # @return [Integer]
   #
   # @see #length
   #
@@ -110,8 +109,6 @@ class Sketchup::AttributeDictionaries < Sketchup::Entity
   # The {#length} method returns the number of attribute dictionary objects in
   # the collection.
   #
-  # The {#size} method is an alias for {#length}.
-  #
   # @example
   #   model = Sketchup.active_model
   #   model.set_attribute('Example', 'Hello', 'World')
@@ -121,23 +118,23 @@ class Sketchup::AttributeDictionaries < Sketchup::Entity
   # @return [Integer] the number of attribute dictionary objects in the
   #   collection.
   #
+  # @see #size
+  #
   # @version SketchUp 2014
   def length
   end
 
-  # The {#length} method returns the number of attribute dictionary objects in
-  # the collection.
-  #
-  # The {#size} method is an alias for {#length}.
+  # The {#size} method is an alias of {#length}.
   #
   # @example
   #   model = Sketchup.active_model
   #   model.set_attribute('Example', 'Hello', 'World')
   #   dictionaries = model.attribute_dictionaries
-  #   number = dictionaries.length
+  #   number = dictionaries.size
   #
-  # @return [Integer] the number of attribute dictionary objects in the
-  #   collection.
+  # @return [Integer]
+  #
+  # @see #length
   #
   # @version SketchUp 2014
   def size

data/SketchUp/Sketchup/AttributeDictionary.rb

@@ -77,7 +77,7 @@ class Sketchup::AttributeDictionary < Sketchup::Entity
   #   dictionary = model.attribute_dictionary('Example')
   #   number = dictionary.count
   #
-  # @return [Integer] the size of the attribute dictionary.
+  # @return [Integer]
   #
   # @version SketchUp 2014
   def count
@@ -105,79 +105,83 @@ class Sketchup::AttributeDictionary < Sketchup::Entity
   def delete_key(key)
   end
 
-  # An alias for each. See AttributeDictionary.each.
-  #
-  # Throws an exception if there are no keys.
+  # The {#each} method iterate through all of the attributes.
   #
   # @example
   #   create_if_nil = true
   #   model = Sketchup.active_model
-  #   attrdict = model.attribute_dictionary "test_dict", create_if_nil
+  #   attrdict = model.attribute_dictionary("test_dict", create_if_nil)
   #   attrdict["attr_one"] = "one"
   #   attrdict["attr_two"] = "two"
   #
-  #   # iterates through all attributes and prints the key to the screen
+  #   # Iterates through all attributes and prints the key to the screen.
   #   attrdict = model.attribute_dictionaries['test_dict']
-  #   attrdict.each_pair { | key, value |
-  #     UI.messagebox key.to_s + '=' + value.to_s
+  #   attrdict.each { | key, value |
+  #     puts "#{key} = #{value}"
   #   }
   #
-  # @return nil
+  # @see #each_pair
   #
   # @version SketchUp 6.0
   #
-  # @yield [key, value] @yieldparam key           The key of each attribute as it is found.
-  #   @yieldparam value         The value of each attribute as it is found.
+  # @yield [key, value]
+  #
+  # @yieldparam [Object] value
+  #   The value of each attribute as it is found.
+  #
+  # @yieldparam [String] key
+  #   The key of each attribute as it is found.
   def each
   end
 
-  # The each_key method is used to iterate through all of the attribute keys.
-  # This is the same method as AttributeDictionary.each.
-  #
-  # Throws an exception if there are no keys.
+  # The {#each_key} method is used to iterate through all of the attribute keys.
   #
   # @example
   #   create_if_nil = true
   #   model = Sketchup.active_model
-  #   attrdict = model.attribute_dictionary "test_dict", create_if_nil
+  #   attrdict = model.attribute_dictionary("test_dict", create_if_nil)
   #   attrdict["attr_one"] = "one"
   #   attrdict["attr_two"] = "two"
   #
   #   # iterates through all attributes and prints the key to the screen
   #   attrdict = model.attribute_dictionaries['test_dict']
-  #   attrdict.each_key { | key | UI.messagebox key }
+  #   attrdict.each_key { |key| puts key }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   #
-  # @yield [key] A variable that will hold each key as they are found.
+  # @yieldparam [String] key
+  #   The key of each attribute as it is found.
   def each_key
   end
 
-  # An alias for each. See AttributeDictionary.each.
-  #
-  # Throws an exception if there are no keys.
+  # The {#each_pair} method is an alias for {#each}.
   #
   # @example
   #   create_if_nil = true
   #   model = Sketchup.active_model
-  #   attrdict = model.attribute_dictionary "test_dict", create_if_nil
+  #   attrdict = model.attribute_dictionary("test_dict", create_if_nil)
   #   attrdict["attr_one"] = "one"
   #   attrdict["attr_two"] = "two"
   #
   #   # iterates through all attributes and prints the key to the screen
   #   attrdict = model.attribute_dictionaries['test_dict']
   #   attrdict.each_pair { | key, value |
-  #     UI.messagebox key.to_s + '=' + value.to_s
+  #     puts "#{key} = #{value}"
   #   }
   #
-  # @return nil
+  # @see #each
   #
   # @version SketchUp 6.0
   #
-  # @yield [key, value] @yieldparam key           The key of each attribute as it is found.
-  #   @yieldparam value         The value of each attribute as it is found.
+  # @yield [key, value]
+  #
+  # @yieldparam [Object] value
+  #   The value of each attribute as it is found.
+  #
+  # @yieldparam [String] key
+  #   The key of each attribute as it is found.
   def each_pair
   end
 
@@ -204,16 +208,15 @@ class Sketchup::AttributeDictionary < Sketchup::Entity
   # The {#length} method is used to retrieve the size (number of elements) of an
   # attribute dictionary.
   #
-  # The {#size} method is an alias for {#length}.
-  #
   # @example
   #   model = Sketchup.active_model
   #   model.set_attribute('Example', 'Hello', 'World')
   #   dictionary = model.attribute_dictionary('Example')
   #   number = dictionary.length
   #
-  # @return [Integer] the size of the attribute dictionary if
-  #   successful
+  # @return [Integer]
+  #
+  # @see #size
   #
   # @version SketchUp 6.0
   def length
@@ -238,19 +241,17 @@ class Sketchup::AttributeDictionary < Sketchup::Entity
   def name
   end
 
-  # The {#length} method is used to retrieve the size (number of elements) of an
-  # attribute dictionary.
-  #
-  # The {#size} method is an alias for {#length}.
+  # The {#size} method is an alias of {#length}.
   #
   # @example
   #   model = Sketchup.active_model
   #   model.set_attribute('Example', 'Hello', 'World')
   #   dictionary = model.attribute_dictionary('Example')
-  #   number = dictionary.length
+  #   number = dictionary.size
   #
-  # @return [Integer] the size of the attribute dictionary if
-  #   successful
+  # @return [Integer]
+  #
+  # @see #length
   #
   # @version SketchUp 6.0
   def size

data/SketchUp/Sketchup/Classifications.rb

@@ -60,12 +60,14 @@ class Sketchup::Classifications
   def keys
   end
 
-  # The length method returns the number of loaded classification schemas.
+  # The {#length} method returns the number of loaded classification schemas.
   #
   # @example
-  #   Sketchup.active_model.classifications.size
+  #   Sketchup.active_model.classifications.length
+  #
+  # @return [Integer]
   #
-  # @return integer - number of ClassificationSchema object
+  # @see #size
   #
   # @version SketchUp 2015
   def length
@@ -88,12 +90,14 @@ class Sketchup::Classifications
   def load_schema(file)
   end
 
-  # The length method returns the number of loaded classification schemas.
+  # The {#size} method returns the number of loaded classification schemas.
   #
   # @example
   #   Sketchup.active_model.classifications.size
   #
-  # @return integer - number of ClassificationSchema object
+  # @return [Integer]
+  #
+  # @see #length
   #
   # @version SketchUp 2015
   def size

data/SketchUp/Sketchup/DefinitionList.rb

@@ -154,15 +154,14 @@ class Sketchup::DefinitionList < Sketchup::Entity
   # The {#length} method is used to retrieve number of component definitions in
   # the list.
   #
-  # The {#size} method is an alias for {#length} added in SketchUp 2014.
-  #
   # @example
   #   model = Sketchup.active_model
   #   definitions = model.definitions
   #   number = definitions.length
   #
-  # @return [Integer] the number of component definitions in the
-  #   definition list if successful
+  # @return [Integer]
+  #
+  # @see #size
   #
   # @version SketchUp 6.0
   def length
@@ -276,20 +275,18 @@ class Sketchup::DefinitionList < Sketchup::Entity
   def remove_observer(observer)
   end
 
-  # The {#length} method is used to retrieve number of component definitions in
-  # the list.
-  #
-  # The {#size} method is an alias for {#length} added in SketchUp 2014.
+  # The {#size} method is an alias for {#length}.
   #
   # @example
   #   model = Sketchup.active_model
   #   definitions = model.definitions
-  #   number = definitions.length
+  #   number = definitions.size
   #
-  # @return [Integer] the number of component definitions in the
-  #   definition list if successful
+  # @return [Integer]
   #
-  # @version SketchUp 6.0
+  # @see #length
+  #
+  # @version SketchUp 2014
   def size
   end