sketchup-api-stubs 0.1.0 → 0.1.1

data/SketchUp/Sketchup/OptionsProvider.rb

@@ -80,8 +80,7 @@ class Sketchup::OptionsProvider
   #   +Enumable+ mix-in module. Prior to that the {#count} method is an alias
   #   for {#length}.
   #
-  # @return integer - the size of the options provider if
-  #   successful
+  # @return [Integer]
   #
   # @see #length
   #
@@ -89,60 +88,60 @@ class Sketchup::OptionsProvider
   def count
   end
 
-  # The each method is used to iterate through all of the attributes.
-  #
-  # Throws an exception if there are no keys.
-  #
-  # The {#each_pair} method is an alias of {#each}.
+  # The {#each} method is used to iterate through all of the options.
   #
   # @example
-  #   # Retrieves each key
-  #   provider.each { |key, value| UI.messagebox key }
-  #   # Retrieves each corresponding value
-  #   provider.each { |key, value| UI.messagebox value }
+  #   model = Sketchup.active_model.options
+  #   provider = model.options['UnitsOptions']
+  #   provider.each { |key, value| puts "#{key} = #{value}" }
   #
-  # @return nil
+  # @return [nil]
+  #
+  # @see #each_key
   #
   # @version SketchUp 6.0
   #
-  # @yield [key, value] Variables that will hold each key and value as they are
-  #   found.
+  # @yield [key, value]
+  #
+  # @yieldparam [Object] value
+  #
+  # @yieldparam [String] key
   def each
   end
 
-  # The each_key method is used to iterate through all of the attribute keys.
-  #
-  # Throws an exception if there are no keys.
+  # The {#each_key} method is used to iterate through all of the attribute keys.
   #
   # @example
   #   provider.each_key { |key| UI.messagebox key }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   #
-  # @yield [key] A variable that will hold each key as they are found.
+  # @yield [key]
+  #
+  # @yieldparam [String] key
   def each_key
   end
 
-  # The each method is used to iterate through all of the attributes.
-  #
-  # Throws an exception if there are no keys.
-  #
-  # The {#each_pair} method is an alias of {#each}.
+  # The {#each} method is used to iterate through all of the options.
   #
   # @example
-  #   # Retrieves each key
-  #   provider.each { |key, value| UI.messagebox key }
-  #   # Retrieves each corresponding value
-  #   provider.each { |key, value| UI.messagebox value }
+  #   model = Sketchup.active_model.options
+  #   provider = model.options['UnitsOptions']
+  #   provider.each { |key, value| puts "#{key} = #{value}" }
   #
-  # @return nil
+  # @return [nil]
+  #
+  # @see #each_key
   #
   # @version SketchUp 6.0
   #
-  # @yield [key, value] Variables that will hold each key and value as they are
-  #   found.
+  # @yield [key, value]
+  #
+  # @yieldparam [Object] value
+  #
+  # @yieldparam [String] key
   def each_pair
   end
 
@@ -162,38 +161,43 @@ class Sketchup::OptionsProvider
   def each_value
   end
 
-  # The key? method is used to determine if the options provider has a specific
-  # key. This method is the same as has_key? See also OptionsManager.has_key
+  # The {#has_key?} method is an alias for {#key?}.
   #
   # @example
-  #   status = provider.key? "name"
+  #   model = Sketchup.active_model.options
+  #   provider = model.options['UnitsOptions']
+  #   p provider.has_key?("LengthFormat")
   #
-  # @param name
+  # @param [String] name
   #   The name of the key you are looking for.
   #
-  # @return status - true if the key exists, false if the key does
-  #   not exist.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
+  # @see #key?
+  #
   # @version SketchUp 6.0
   def has_key?(name)
   end
 
-  # The key? method is used to determine if the options provider has a specific
-  # key. This method is the same as has_key? See also OptionsManager.has_key
+  # The {#key?} method is used to determine if the options provider has a
+  # specific key.
   #
   # @example
-  #   status = provider.key? "name"
+  #   model = Sketchup.active_model.options
+  #   provider = model.options['UnitsOptions']
+  #   p provider.key?("LengthFormat")
   #
-  # @param name
+  # @param [String] name
   #   The name of the key you are looking for.
   #
-  # @return status - true if the key exists, false if the key does
-  #   not exist.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
+  # @see #has_key?
+  #
   # @version SketchUp 6.0
   def key?(name)
   end
@@ -216,19 +220,17 @@ class Sketchup::OptionsProvider
   def keys
   end
 
-  # The {#size} method is used to retrieve the size (number of elements) of an
-  # options provider.
-  #
   # The {#length} method is an alias of {#size}.
   #
   # @example
   #   optionsprovider = Sketchup.active_model.options['UnitsOptions']
-  #   number = optionsprovider.size
+  #   number = optionsprovider.length
   #
-  # @return integer - the size of the options provider if
-  #   successful
+  # @return [Integer]
   #
-  # @version SketchUp 6.0
+  # @see #size
+  #
+  # @version SketchUp 2014
   def length
   end
 
@@ -261,14 +263,13 @@ class Sketchup::OptionsProvider
   # The {#size} method is used to retrieve the size (number of elements) of an
   # options provider.
   #
-  # The {#length} method is an alias of {#size}.
-  #
   # @example
   #   optionsprovider = Sketchup.active_model.options['UnitsOptions']
   #   number = optionsprovider.size
   #
-  # @return integer - the size of the options provider if
-  #   successful
+  # @return [Integer]
+  #
+  # @see #length
   #
   # @version SketchUp 6.0
   def size

data/SketchUp/Sketchup/Pages.rb

@@ -176,7 +176,7 @@ class Sketchup::Pages < Sketchup::Entity
   #   +Enumable+ mix-in module. Prior to that the {#count} method is an alias
   #   for {#length}.
   #
-  # @return integer - the number of pages if successful
+  # @return [Integer]
   #
   # @see #length
   #
@@ -216,19 +216,19 @@ class Sketchup::Pages < Sketchup::Entity
   def erase(page)
   end
 
-  # The {#size} method is used to retrieve the number of pages.
-  #
   # The {#length} method is an alias for {#size}.
   #
   # @example
   #   pages = Sketchup.active_model.pages
   #   pages.add('Page 1')
   #   pages.add('Page 2')
-  #   number = pages.size
+  #   number = pages.length
   #
-  # @return integer - the number of pages if successful
+  # @return [Integer]
   #
-  # @version SketchUp 6.0
+  # @see #size
+  #
+  # @version SketchUp 2014
   def length
   end
 
@@ -318,15 +318,15 @@ class Sketchup::Pages < Sketchup::Entity
 
   # The {#size} method is used to retrieve the number of pages.
   #
-  # The {#length} method is an alias for {#size}.
-  #
   # @example
   #   pages = Sketchup.active_model.pages
   #   pages.add('Page 1')
   #   pages.add('Page 2')
   #   number = pages.size
   #
-  # @return integer - the number of pages if successful
+  # @return [Integer]
+  #
+  # @see #length
   #
   # @version SketchUp 6.0
   def size

data/SketchUp/Sketchup/RenderingOptions.rb

@@ -228,22 +228,33 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   #   options = Sketchup.active_model.rendering_options
   #   number = options.count
   #
-  # @return integer
+  # @return [Integer]
   #
   # @version SketchUp 2014
   def count
   end
 
-  # An alias for each. See RenderingOptions.each.
+  # The {#each} method iterates through all of the rendering options key/value
+  # pairs.
   #
   # @example
-  #   Sketchup.active_model.rendering_options.each_pair { |key, value|
+  #   Sketchup.active_model.rendering_options.each { |key, value|
   #     puts "#{key} : #{value}"
   #   }
   #
-  # @return nil
+  # @return [nil]
+  #
+  # @see #each_pair
   #
   # @version SketchUp 6.0
+  #
+  # @yield [key, value]
+  #
+  # @yieldparam [Object] value
+  #   The value of each pair found.
+  #
+  # @yieldparam [String] key
+  #   The key of each pair found.
   def each
   end
 
@@ -262,14 +273,16 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   def each_key
   end
 
-  # An alias for each. See RenderingOptions.each.
+  # The {#each_pair} method is an alias for {#each}.
   #
   # @example
   #   Sketchup.active_model.rendering_options.each_pair { |key, value|
   #     puts "#{key} : #{value}"
   #   }
   #
-  # @return nil
+  # @return [nil]
+  #
+  # @see #each
   #
   # @version SketchUp 6.0
   def each_pair
@@ -287,15 +300,15 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   end
 
   # The {#length} method returns the number of options in the rendering options
-  # collection
-  #
-  # The {#size} method is an alias for {#length}.
+  # collection.
   #
   # @example
   #   options = Sketchup.active_model.rendering_options
   #   number = options.length
   #
-  # @return integer
+  # @return [Integer]
+  #
+  # @see #size
   #
   # @version SketchUp 2014
   def length
@@ -319,16 +332,15 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   def remove_observer(observer)
   end
 
-  # The {#length} method returns the number of options in the rendering options
-  # collection
-  #
   # The {#size} method is an alias for {#length}.
   #
   # @example
   #   options = Sketchup.active_model.rendering_options
-  #   number = options.length
+  #   number = options.size
+  #
+  # @return [Integer]
   #
-  # @return integer
+  # @see #length
   #
   # @version SketchUp 2014
   def size

data/SketchUp/Sketchup/Selection.rb

@@ -21,39 +21,26 @@ class Sketchup::Selection
 
   # Instance Methods
 
-  # The [] method is used to retrieve an Entity object from the selection by
-  # index. Index 0 is the first entity in the selection.
+  # The {#[]} method is used to retrieve an {Sketchup::Entity} from the selection
+  # by index. Index 0 is the first entity in the selection.
   #
   # This method is not very efficient. If you need to look at every entity in
-  # the selection, consider using Selection.each instead of using this method
+  # the selection, consider using {#each} instead of using this method
   # to manually grab each one.
   #
   # @example
-  #   depth = 100
-  #   width = 100
   #   model = Sketchup.active_model
   #   entities = model.active_entities
-  #   pts = []
-  #   pts[0] = [0, 0, 0]
-  #   pts[1] = [width, 0, 0]
-  #   pts[2] = [width, depth, 0]
-  #   pts[3] = [0, depth, 0]
-  #   # Add the face to the entities in the model
-  #   face = entities.add_face pts
   #   selection = model.selection
-  #   entity = entities[0]
-  #   status = selection.add entity
-  #   entity = selection[0]
-  #   if (entity)
-  #     UI.messagebox entity
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
-  #
-  # @param index
+  #   selection.add(entities.to_a)
+  #   p selection[0]
+  #
+  # @param [Integer] index
   #   The index of the Entity object to retrieve.
   #
-  # @return entity - an Entity object if successful
+  # @return [Sketchup::Entitiy, nil]
+  #
+  # @see #at
   #
   # @version SketchUp 6.0
   def [](index)
@@ -104,39 +91,21 @@ class Sketchup::Selection
   def add_observer(observer)
   end
 
-  # The [] method is used to retrieve an Entity object from the selection by
-  # index. Index 0 is the first entity in the selection.
-  #
-  # This method is not very efficient. If you need to look at every entity in
-  # the selection, consider using Selection.each instead of using this method
-  # to manually grab each one.
+  # The {#at} method is an alias for {#[]}.
   #
   # @example
-  #   depth = 100
-  #   width = 100
   #   model = Sketchup.active_model
   #   entities = model.active_entities
-  #   pts = []
-  #   pts[0] = [0, 0, 0]
-  #   pts[1] = [width, 0, 0]
-  #   pts[2] = [width, depth, 0]
-  #   pts[3] = [0, depth, 0]
-  #   # Add the face to the entities in the model
-  #   face = entities.add_face pts
   #   selection = model.selection
-  #   entity = entities[0]
-  #   status = selection.add entity
-  #   entity = selection[0]
-  #   if (entity)
-  #     UI.messagebox entity
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
-  #
-  # @param index
+  #   selection.add(entities.to_a)
+  #   p selection.at(0)
+  #
+  # @param [Integer] index
   #   The index of the Entity object to retrieve.
   #
-  # @return entity - an Entity object if successful
+  # @return [Sketchup::Entitiy, nil]
+  #
+  # @see #[]
   #
   # @version SketchUp 6.0
   def at(index)
@@ -156,20 +125,23 @@ class Sketchup::Selection
   def clear
   end
 
-  # The include? method is an alias for contains
+  # The {contains?} method is and alias of {#include?}.
   #
   # @example
-  #   selection.add entity
-  #   status = selection.include? entity
+  #   model = Sketchup.active_model
+  #   entity = model.active_entities.first
+  #   selection = model.selection
+  #   selection.add(entity)
+  #   p selection.contains?(entity)
   #
-  # @param entity
-  #   An Entity object.
+  # @param [Sketchup::Entity] entity
   #
-  # @return status - true if the Entity object is in the selection.
-  #   False if the Entity object is not in the selection.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
+  # @see #include?
+  #
   # @version SketchUp 6.0
   def contains?(entity)
   end
@@ -183,8 +155,7 @@ class Sketchup::Selection
   #   +Enumable+ mix-in module. Prior to that the {#count} method is an alias
   #   for {#length}.
   #
-  # @return integer - the number of Entities in the selection if
-  #   successful
+  # @return [Integer]
   #
   # @see #length
   #
@@ -241,20 +212,24 @@ class Sketchup::Selection
   def first
   end
 
-  # The include? method is an alias for contains
+  # The {include?} method is used to determine if a given {Sketchup::Entity} is
+  # in the selection.
   #
   # @example
-  #   selection.add entity
-  #   status = selection.include? entity
+  #   model = Sketchup.active_model
+  #   entity = model.active_entities.first
+  #   selection = model.selection
+  #   selection.add(entity)
+  #   p selection.include?(entity)
   #
-  # @param entity
-  #   An Entity object.
+  # @param [Sketchup::Entity] entity
   #
-  # @return status - true if the Entity object is in the selection.
-  #   False if the Entity object is not in the selection.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
+  # @see #contains?
+  #
   # @version SketchUp 6.0
   def include?(entity)
   end
@@ -294,18 +269,17 @@ class Sketchup::Selection
   def is_surface?
   end
 
-  # The {#length} method is used to retrieve the number of selected Entities.
-  #
-  # The {#nitems} methods is an alias of {#length}.
-  #
-  # The {#size} methods is an alias of {#length} added in SketchUp 2014.
+  # The {#length} method is used to retrieve the number of selected entities.
   #
   # @example
   #   selection = Sketchup.active_model.selection
   #   number = selection.length
   #
-  # @return integer - the number of entities in the selection if
-  #   successful
+  # @return [Integer]
+  #
+  # @see #nitems
+  #
+  # @see #size
   #
   # @version SketchUp 6.0
   def length
@@ -323,18 +297,15 @@ class Sketchup::Selection
   def model
   end
 
-  # The {#length} method is used to retrieve the number of selected Entities.
-  #
-  # The {#nitems} methods is an alias of {#length}.
-  #
-  # The {#size} methods is an alias of {#length} added in SketchUp 2014.
+  # The {#nitems} method is an alias for {#length}.
   #
   # @example
   #   selection = Sketchup.active_model.selection
-  #   number = selection.length
+  #   number = selection.nitems
   #
-  # @return integer - the number of entities in the selection if
-  #   successful
+  # @return [Integer]
+  #
+  # @see #length
   #
   # @version SketchUp 6.0
   def nitems
@@ -419,20 +390,17 @@ class Sketchup::Selection
   def single_object?
   end
 
-  # The {#length} method is used to retrieve the number of selected Entities.
-  #
-  # The {#nitems} methods is an alias of {#length}.
-  #
-  # The {#size} methods is an alias of {#length} added in SketchUp 2014.
+  # The {#size} method is an alias for {#length}.
   #
   # @example
   #   selection = Sketchup.active_model.selection
-  #   number = selection.length
+  #   number = selection.size
   #
-  # @return integer - the number of entities in the selection if
-  #   successful
+  # @return [Integer]
   #
-  # @version SketchUp 6.0
+  # @see #length
+  #
+  # @version SketchUp 2014
   def size
   end