sketchup-api-stubs 0.4.0 → 0.5.0

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Entity.rb

@@ -118,7 +118,7 @@ class Sketchup::Entity
   #   if successful, or nil if there is no attribute dictionary
   #
   # @version SketchUp 6.0
-  def attribute_dictionary(name, create)
+  def attribute_dictionary(name, create = false)
   end
 
   # The {#delete_attribute} method is used to delete an attribute from an entity.
@@ -189,8 +189,6 @@ class Sketchup::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def deleted?
   end
@@ -532,8 +530,6 @@ class Sketchup::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def valid?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Face.rb

@@ -277,21 +277,33 @@ class Sketchup::Face < Sketchup::Drawingelement
   #   tw = Sketchup.create_texture_writer
   #   uvHelp = face.get_UVHelper(true, true, tw)
   #
-  # @param [Boolean] front
-  #   True if you want the texture coordinates for the front
-  #   face, false if not. Defaults to true.
+  # @overload get_UVHelper(front = true, back = true)
   #
-  # @param [Boolean] back
-  #   True if you want the texture coordinates for the back
-  #   face, false if not. Defaults to true.
+  #   @param [Boolean] front
+  #    True if you want the texture coordinates for the front
+  #    face, false if not.
   #
-  # @param [Sketchup::TextureWriter] texturewriter
-  #   An optional TextureWriter object.
+  #   @param [Boolean] back
+  #    True if you want the texture coordinates for the back
+  #    face, false if not.
   #
-  # @return [Sketchup::UVHelper] a UVHelper object
+  # @overload get_UVHelper(front = true, back = true, texturewriter)
+  #
+  #   @param [Boolean] front
+  #    True if you want the texture coordinates for the front
+  #    face, false if not.
+  #
+  #   @param [Boolean] back
+  #    True if you want the texture coordinates for the back
+  #    face, false if not.
+  #
+  #   @param [Sketchup::TextureWriter] texturewriter
+  #    An optional TextureWriter object.
+  #
+  # @return [Sketchup::UVHelper]
   #
   # @version SketchUp 6.0
-  def get_UVHelper(front, back, texturewriter)
+  def get_UVHelper(*args)
   end
 
   # The get_glued_instances method returns an Array any ComponentInstances

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Group.rb

@@ -178,8 +178,6 @@ class Sketchup::Group < Sketchup::Drawingelement
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 8.0
   def equals?(group)
   end
@@ -301,8 +299,6 @@ class Sketchup::Group < Sketchup::Drawingelement
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def locked?
   end
@@ -341,8 +337,6 @@ class Sketchup::Group < Sketchup::Drawingelement
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 8.0
   def manifold?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Importer.rb

@@ -183,8 +183,6 @@ class Sketchup::Importer
   #
   # @return supports_options - a boolean
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def supports_options?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/InputPoint.rb

@@ -145,8 +145,6 @@ class Sketchup::InputPoint
   # @return status - true if the draw method will draw something,
   #   false if the draw method has nothing to draw
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def display?
   end
@@ -370,8 +368,6 @@ class Sketchup::InputPoint
   # @return status - true if the input point has valid data, false
   #   if it does not have valid data.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def valid?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Layer.rb

@@ -255,8 +255,6 @@ class Sketchup::Layer < Sketchup::Entity
   #
   # @return true if the layer is visible
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def visible?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Licensing/ExtensionLicense.rb

@@ -59,8 +59,6 @@ class Sketchup::Licensing::ExtensionLicense
   # @return Boolean - true if the extension is allowed to run, false
   #   if it is not licensed and should quit.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 2015
   def licensed?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Loop.rb

@@ -28,8 +28,6 @@ class Sketchup::Loop < Sketchup::Entity
   #
   # @return status - true if convex, false if not convex.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def convex?
   end
@@ -113,8 +111,6 @@ class Sketchup::Loop < Sketchup::Entity
   # @return status - true if the loop is an outer loop, false if it
   #   is not an outer loop.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def outer?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Material.rb

@@ -370,8 +370,6 @@ class Sketchup::Material < Sketchup::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def use_alpha?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Model.rb

@@ -847,8 +847,6 @@ class Sketchup::Model
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 7.0
   def mipmapping?
   end
@@ -865,8 +863,6 @@ class Sketchup::Model
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def modified?
   end
@@ -1102,7 +1098,7 @@ class Sketchup::Model
   # @example
   #   model = Sketchup.active_model
   #   # Save the model using the current SketchUp format
-  #   filename = File.join(ENV['Home'], 'Desktop', 'mysketchup.skp')
+  #   filename = File.join(ENV['HOME'], 'Desktop', 'mysketchup.skp')
   #   status = model.save(filename)
   #   # Save the model to the current file using the current SketchUp format
   #   status = model.save
@@ -1478,8 +1474,6 @@ class Sketchup::Model
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def valid?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Page.rb

@@ -155,8 +155,6 @@ class Sketchup::Page < Sketchup::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 2018
   def include_in_animation?
   end
@@ -392,8 +390,6 @@ class Sketchup::Page < Sketchup::Entity
   #   the page, false if you are not storing this property
   #   with the page.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def use_axes?
   end
@@ -430,8 +426,6 @@ class Sketchup::Page < Sketchup::Entity
   #   the page, false if you are not storing this property
   #   with the page.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def use_camera?
   end
@@ -468,8 +462,6 @@ class Sketchup::Page < Sketchup::Entity
   #   the page, false if you are not storing this property
   #   with the page.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def use_hidden?
   end
@@ -507,8 +499,6 @@ class Sketchup::Page < Sketchup::Entity
   #   the page, false if you are not storing this property
   #   with the page.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def use_hidden_layers?
   end
@@ -546,8 +536,6 @@ class Sketchup::Page < Sketchup::Entity
   #   the page, false if you are not storing this property
   #   with the page.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def use_rendering_options?
   end
@@ -585,8 +573,6 @@ class Sketchup::Page < Sketchup::Entity
   #   the page, false if you are not storing this property
   #   with the page.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def use_section_planes?
   end
@@ -623,8 +609,6 @@ class Sketchup::Page < Sketchup::Entity
   #   the page, false if you are not storing this property
   #   with the page.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def use_shadow_info?
   end
@@ -659,8 +643,6 @@ class Sketchup::Page < Sketchup::Entity
   #   the page, false if you are not storing this property
   #   with the page.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def use_style?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/SectionPlane.rb

@@ -38,8 +38,6 @@ class Sketchup::SectionPlane < Sketchup::Drawingelement
   #
   # @return boolean - true if active
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 2014
   def active?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Selection.rb

@@ -67,13 +67,18 @@ class Sketchup::Selection
   #   entity = entities[0]
   #   status = selection.add entity
   #
-  # @param [Array<Sketchup::Entity>] ents_or_array
-  #   List or Array of Entity objects.
+  # @overload add(entities)
+  #
+  #   @param [Array<Sketchup::Entity>] entities
+  #
+  # @overload add(*entities)
+  #
+  #   @param [Array<Sketchup::Entity>] entities
   #
   # @return [Integer] the number of Entity objects added
   #
   # @version SketchUp 6.0
-  def add(ents_or_array)
+  def add(*args)
   end
 
   # The add_observer method is used to add an observer to the selection object.
@@ -189,8 +194,6 @@ class Sketchup::Selection
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def empty?
   end
@@ -225,8 +228,6 @@ class Sketchup::Selection
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @see #contains?
   #
   # @version SketchUp 6.0
@@ -242,8 +243,6 @@ class Sketchup::Selection
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def is_curve?
   end
@@ -257,8 +256,6 @@ class Sketchup::Selection
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def is_surface?
   end
@@ -325,13 +322,18 @@ class Sketchup::Selection
   #   entity = entities[0]
   #   status = selection.add entity
   #
-  # @param [Array<Sketchup::Entity>] ents_or_array
-  #   List or Array of Entity objects.
+  # @overload remove(entities)
+  #
+  #   @param [Array<Sketchup::Entity>] entities
+  #
+  # @overload remove(*entities)
+  #
+  #   @param [Array<Sketchup::Entity>] entities
   #
   # @return [Integer] the number of Entity objects removed
   #
   # @version SketchUp 6.0
-  def remove(ents_or_array)
+  def remove(*args)
   end
 
   # The remove_observer method is used to remove an observer from the selection
@@ -376,8 +378,6 @@ class Sketchup::Selection
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def single_object?
   end
@@ -418,13 +418,18 @@ class Sketchup::Selection
   #   entity = entities[0]
   #   status = selection.add entity
   #
-  # @param [Array<Sketchup::Entity>] ents_or_array
-  #   List or Array of Entity objects.
+  # @overload toggle(entities)
+  #
+  #   @param [Array<Sketchup::Entity>] entities
+  #
+  # @overload toggle(*entities)
+  #
+  #   @param [Array<Sketchup::Entity>] entities
   #
   # @return [Integer] the number of Entity objects changed
   #
   # @version SketchUp 6.0
-  def toggle(ents_or_array)
+  def toggle(*args)
   end
 
 end