sketchup-api-stubs 0.1.0 → 0.1.1

data/SketchUp/Sketchup/Set.rb

@@ -7,35 +7,35 @@
 #
 # To make a set of your own, create an empty one using Sketchup::Set.new, and
 # then add items to it.
-# Note that in SketchUp 2014 this class was changed from Set to Sketchup::Set
-# in order to avoid conflict with the Ruby Standard Library. The Sketchup::Set
-# class is deprecated and new extensions should make use of Ruby's Set class
-# unless they need backward compatibility.
 #
-# If you want to ensure backwards compatibility you can use this shim:
+# @deprecated In SketchUp 2014 this class was changed from +Set+
+#   to +Sketchup::Set+ in order to avoid conflict with the Ruby Standard
+#   Library. The +Sketchup::Set+ class is deprecated and new extensions should
+#   make use of Ruby's +Set+ class unless they need backward compatibility.
 #
 # @example
+#   set = Sketchup::Set.new
+#   set.insert(1)
+#   set.insert(2)
+#
+# @example Compatibility Shim
 #   module Example
 #
 #     # Shim for the Set class which was moved in SketchUp 2014
 #     if defined?(Sketchup::Set)
+#       # Warning! Do NOT do this in the global namespace!
 #       Set = Sketchup::Set
 #     end
 #
 #     def self.test_set_shim
-#       s = Set.new
-#       s.insert('Hello')
-#       s.insert('World')
-#       puts s.to_a
+#       set = Set.new
+#       set.insert('Hello')
+#       set.insert('World')
+#       puts set.to_a
 #     end
 #
 #   end
 #
-# @example
-#   my_set = Sketchup::Set.new
-#   my_set.insert entity1
-#   my_set.insert entity2
-#
 # @version SketchUp 6.0
 class Sketchup::Set
 
@@ -45,19 +45,10 @@ class Sketchup::Set
   #
   # @example
   #   set = Sketchup::Set.new
-  #   toolbar = UI::Toolbar.new "Test"
-  #   set.insert toolbar
-  #   if (set.include? toolbar)
-  #     UI.messagebox "Success: Contains Toolbar Object"
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
   #   set.clear
-  #   if (set.include? toolbar)
-  #     UI.messagebox set
-  #   else
-  #     UI.messagebox "Set is empty"
-  #   end
   #
   # @return set - an empty Set object
   #
@@ -65,47 +56,34 @@ class Sketchup::Set
   def clear
   end
 
-  # The contains? method is an alias for include?. See also Set.include?
+  # The {#contains?} method is an alias for {#include?}.
   #
   # @example
   #   set = Sketchup::Set.new
-  #   toolbar = UI::Toolbar.new "Test"
-  #   set.insert toolbar
-  #   if (set.contains? toolbar)
-  #     UI.messagebox "Success: Contains Toolbar Object"
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   p set.contains?(2)
   #
-  # @param object
-  #   A Ruby object of any type.
+  # @param [Sketchup::Entity] entity
   #
-  # @return status - true if the set contains the object, false if
-  #   the set does not contain the object.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
+  # @see #include?
+  #
   # @version SketchUp 6.0
-  def contains?(object)
+  def contains?(entity)
   end
 
   # The delete object is used to delete or remove an object from the set.
   #
   # @example
   #   set = Sketchup::Set.new
-  #   toolbar = UI::Toolbar.new "Test"
-  #   set.insert toolbar
-  #   if (set.include? toolbar)
-  #     UI.messagebox "Success: Contains Toolbar Object"
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
-  #   set.delete toolbar
-  #   if (set.include? toolbar)
-  #     UI.messagebox set
-  #   else
-  #     UI.messagebox "Set is empty"
-  #   end
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.delete(1)
   #
   # @param object
   #   The object to be deleted.
@@ -120,9 +98,10 @@ class Sketchup::Set
   #
   # @example
   #   set = Sketchup::Set.new
-  #   toolbar = UI::Toolbar.new "Test"
-  #   set.insert toolbar
-  #   set.each { | item | UI.messagebox item }
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   set.each { | item | puts item }
   #
   # @version SketchUp 6.0
   #
@@ -134,14 +113,10 @@ class Sketchup::Set
   #
   # @example
   #   set = Sketchup::Set.new
-  #   toolbar = UI::Toolbar.new "Test"
-  #   set.insert toolbar
-  #   status = set.empty?
-  #   if (status)
-  #     UI.messagebox "Success: Set is Empty"
-  #   else
-  #     UI.messagebox "Failure: Set has an Item"
-  #   end
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   puts set.empty?
   #
   # @return status - true if the set is empty, false if it is not
   #   empty.
@@ -152,41 +127,35 @@ class Sketchup::Set
   def empty?
   end
 
-  # The contains? method is an alias for include?. See also Set.include?
+  # The {#include?} method is used to determine if the set includes a particular
+  # object.
   #
   # @example
   #   set = Sketchup::Set.new
-  #   toolbar = UI::Toolbar.new "Test"
-  #   set.insert toolbar
-  #   if (set.contains? toolbar)
-  #     UI.messagebox "Success: Contains Toolbar Object"
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   p set.include?(2)
   #
-  # @param object
-  #   A Ruby object of any type.
+  # @param [Sketchup::Entity] entity
   #
-  # @return status - true if the set contains the object, false if
-  #   the set does not contain the object.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
+  # @see #contains?
+  #
   # @version SketchUp 6.0
-  def include?(object)
+  def include?(entity)
   end
 
   # The insert method is used to insert an object into the set.
   #
   # @example
   #   set = Sketchup::Set.new
-  #   toolbar = UI::Toolbar.new "Test"
-  #   set.insert toolbar
-  #   if (set.include? toolbar)
-  #     UI.messagebox "Success: Contains Toolbar Object"
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
   #
   # @param object
   #   The object to be inserted into the set.
@@ -197,39 +166,35 @@ class Sketchup::Set
   def insert(object)
   end
 
-  # The length method is an alias for size. See also Set.size.
+  # The {#length} method is an alias for {#size}.
   #
   # @example
   #   set = Sketchup::Set.new
-  #   toolbar = UI::Toolbar.new "Test"
-  #   set.insert toolbar
-  #   length = set.length
-  #   if (length)
-  #     UI.messagebox length
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   puts set.length
   #
-  # @return length - the length (number of objects) in the set
+  # @return [Integer]
+  #
+  # @see #size
   #
   # @version SketchUp 6.0
   def length
   end
 
-  # The length method is an alias for size. See also Set.size.
+  # The {#size} method is used to determine the number of objects in the set.
   #
   # @example
   #   set = Sketchup::Set.new
-  #   toolbar = UI::Toolbar.new "Test"
-  #   set.insert toolbar
-  #   length = set.length
-  #   if (length)
-  #     UI.messagebox length
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
-  #
-  # @return length - the length (number of objects) in the set
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   puts set.size
+  #
+  # @return [Integer]
+  #
+  # @see #length
   #
   # @version SketchUp 6.0
   def size

data/SketchUp/Sketchup/ShadowInfo.rb

@@ -138,26 +138,27 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   def count
   end
 
-  # An alias for each. See ShadowInfo.each.
+  # The {#each} method iterates through all of the shadow information key/value
+  # pairs.
   #
   # @example
   #   model = Sketchup.active_model
-  #   shadowinfo = model.shadow_info
-  #   shadowinfo.each_pair { |key, value|
-  #     UI.messagebox(key.to_s + '=' + value.to_s)
+  #   shadow_info = model.shadow_info
+  #   shadow_info.each { |key, value|
+  #     puts "#{key} : #{value}"
   #   }
   #
-  # @return nil
+  # @return [nil]
+  #
+  # @see #each_pair
   #
   # @version SketchUp 6.0
   #
   # @yield [key, value]
   #
-  # @yieldparam key
-  #   A variables that will hold each key as it is found.
+  # @yieldparam [Object] value
   #
-  # @yieldparam value
-  #   A variables that will hold each value as it is found.
+  # @yieldparam [String] key
   def each
   end
 
@@ -174,26 +175,26 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   def each_key
   end
 
-  # An alias for each. See ShadowInfo.each.
+  # The #{each_pair} method is an alias for {#each}.
   #
   # @example
   #   model = Sketchup.active_model
-  #   shadowinfo = model.shadow_info
-  #   shadowinfo.each_pair { |key, value|
-  #     UI.messagebox(key.to_s + '=' + value.to_s)
+  #   shadow_info = model.shadow_info
+  #   shadow_info.each_pair { |key, value|
+  #     puts "#{key} : #{value}"
   #   }
   #
-  # @return nil
+  # @return [nil]
+  #
+  # @see #each
   #
   # @version SketchUp 6.0
   #
   # @yield [key, value]
   #
-  # @yieldparam key
-  #   A variables that will hold each key as it is found.
+  # @yieldparam [String] key
   #
-  # @yieldparam value
-  #   A variables that will hold each value as it is found.
+  # @yieldparam [Object] value
   def each_pair
   end
 
@@ -212,13 +213,13 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   # The {#length} method returns the number of options in the shadow options
   # collection
   #
-  # The {#size} method is an alias for {#length}.
-  #
   # @example
   #   shadow_info = Sketchup.active_model.shadow_info
   #   number = shadow_info.length
   #
-  # @return integer
+  # @return [Integer]
+  #
+  # @see #size
   #
   # @version SketchUp 2014
   def length
@@ -239,16 +240,15 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   def remove_observer(observer)
   end
 
-  # The {#length} method returns the number of options in the shadow options
-  # collection
-  #
   # The {#size} method is an alias for {#length}.
   #
   # @example
   #   shadow_info = Sketchup.active_model.shadow_info
-  #   number = shadow_info.length
+  #   number = shadow_info.size
   #
-  # @return integer
+  # @return [Integer]
+  #
+  # @see #length
   #
   # @version SketchUp 2014
   def size

data/SketchUp/Sketchup/Styles.rb

@@ -112,18 +112,17 @@ class Sketchup::Styles < Sketchup::Entity
   def each
   end
 
-  # The {#size} method is used to retrieve the number of styles in the
-  # collection.
-  #
   # The {#length} method is an alias of {#size}.
   #
   # @example
   #   styles = Sketchup.active_model.styles
-  #   number = styles.size
+  #   number = styles.length
   #
-  # @return integer - the number of styles found.
+  # @return [Integer]
   #
-  # @version SketchUp 6.0
+  # @see #size
+  #
+  # @version SketchUp 2014
   def length
   end
 
@@ -175,13 +174,13 @@ class Sketchup::Styles < Sketchup::Entity
   # The {#size} method is used to retrieve the number of styles in the
   # collection.
   #
-  # The {#length} method is an alias of {#size}.
-  #
   # @example
   #   styles = Sketchup.active_model.styles
   #   number = styles.size
   #
-  # @return integer - the number of styles found.
+  # @return [Integer]
+  #
+  # @see #length
   #
   # @version SketchUp 6.0
   def size

data/SketchUp/UI/Toolbar.rb

@@ -79,7 +79,7 @@ class UI::Toolbar
   # @example
   #   number = toolbar.count
   #
-  # @return integer
+  # @return [Integer]
   #
   # @version SketchUp 2014
   def count
@@ -151,12 +151,12 @@ class UI::Toolbar
 
   # The {#length} method returns the number of items in the toolbar.
   #
-  # The {#size} method is an alias of {#length}.
-  #
   # @example
   #   number = toolbar.length
   #
-  # @return integer
+  # @return [Integer]
+  #
+  # @see #size
   #
   # @version SketchUp 2014
   def length
@@ -214,14 +214,14 @@ class UI::Toolbar
   def show
   end
 
-  # The {#length} method returns the number of items in the toolbar.
-  #
   # The {#size} method is an alias of {#length}.
   #
   # @example
-  #   number = toolbar.length
+  #   number = toolbar.size
+  #
+  # @return [Integer]
   #
-  # @return integer
+  # @see #length
   #
   # @version SketchUp 2014
   def size