sketchup-api-stubs 0.1.0 → 0.1.1

data/SketchUp/Sketchup/Entities.rb

@@ -18,16 +18,9 @@ class Sketchup::Entities
   # general, it is preferable to use the {#each} method to iterate though all
   # of the entities in the collection as it will be much more efficient.
   #
-  # The {#at} method is an alias of {#[]}
-  #
   # @example
   #   entities = Sketchup.active_model.entities
-  #   entity0 = entities[0]
-  #   if (entity0)
-  #     UI.messagebox entity0
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   entity = entities[0]
   #
   # @param [Integer] entity_index
   #   The index for a specific entity.
@@ -35,6 +28,8 @@ class Sketchup::Entities
   # @return [Sketchup::Entity, nil] an {Sketchup::Entity} object if successful,
   #   +nil+ if not found
   #
+  # @see #at
+  #
   # @version SketchUp 6.0
   def [](entity_index)
   end
@@ -658,27 +653,15 @@ class Sketchup::Entities
   def add_text(text, point, vector)
   end
 
-  # The {#[]} method is used to retrieve an entity by its index in an array of
-  # entities. The index is a number between +0+ and entities.length - 1. In
-  # general, it is preferable to use the {#each} method to iterate though all
-  # of the entities in the collection as it will be much more efficient.
-  #
-  # The {#at} method is an alias of {#[]}
+  # The {#at} method is an alias for {#[]}.
   #
   # @example
   #   entities = Sketchup.active_model.entities
-  #   entity0 = entities[0]
-  #   if (entity0)
-  #     UI.messagebox entity0
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   entity = entities.at(0)
   #
-  # @param [Integer] entity_index
-  #   The index for a specific entity.
+  # @return [Sketchup::Entity, nil]
   #
-  # @return [Sketchup::Entity, nil] an {Sketchup::Entity} object if successful,
-  #   +nil+ if not found
+  # @see #[]
   #
   # @version SketchUp 6.0
   def at(entity_index)
@@ -869,16 +852,15 @@ class Sketchup::Entities
   # The {#length} method is used to retrieve the number of entities in the
   # collection of entities.
   #
-  # The {#size} method is an alias for {#length} added in SketchUp 2014.
-  #
   # @example
   #   model = Sketchup.active_model
   #   entities = model.entities
   #   entities.add_cpoint([10, 10, 10])
   #   number = entities.length
   #
-  # @return [Integer] the number of entities in the collection of
-  #   entities if successful
+  # @return [Integer]
+  #
+  # @see #size
   #
   # @version SketchUp 6.0
   def length
@@ -937,21 +919,19 @@ class Sketchup::Entities
   def remove_observer(observer)
   end
 
-  # The {#length} method is used to retrieve the number of entities in the
-  # collection of entities.
-  #
-  # The {#size} method is an alias for {#length} added in SketchUp 2014.
+  # The {#size} method is an alias for the {#length} method.
   #
   # @example
   #   model = Sketchup.active_model
   #   entities = model.entities
   #   entities.add_cpoint([10, 10, 10])
-  #   number = entities.length
+  #   number = entities.size
   #
-  # @return [Integer] the number of entities in the collection of
-  #   entities if successful
+  # @return [Integer]
   #
-  # @version SketchUp 6.0
+  # @see #length
+  #
+  # @version SketchUp 2014
   def size
   end
 

data/SketchUp/Sketchup/ExtensionsManager.rb

@@ -53,8 +53,7 @@ class Sketchup::ExtensionsManager
   #   +Enumable+ mix-in module. Prior to that the {#count} method is an alias
   #   for {#length}.
   #
-  # @return integer - number of SketchupExtension objects if
-  #   successful
+  # @return [Integer]
   #
   # @see #length
   #
@@ -94,33 +93,30 @@ class Sketchup::ExtensionsManager
   def keys
   end
 
-  # The length method returns the number of SketchupExtension objects inside
+  # The {#length} method returns the number of {SketchupExtension} objects inside
   # this ExtensionsManager.
   #
-  # The {#size} method is an alias for {#length}.
-  #
   # @example
   #   manager = Sketchup.extensions
   #   number = manager.length
   #
-  # @return integer - number of SketchupExtension objects if
-  #   successful
+  # @return [Integer]
+  #
+  # @see #size
   #
   # @version SketchUp 8.0 M2
   def length
   end
 
-  # The length method returns the number of SketchupExtension objects inside
-  # this ExtensionsManager.
-  #
-  # The {#size} method is an alias for {#length}.
+  # The {#size} method is an alias of {#length}.
   #
   # @example
   #   manager = Sketchup.extensions
-  #   number = manager.length
+  #   number = manager.size
+  #
+  # @return [Integer]
   #
-  # @return integer - number of SketchupExtension objects if
-  #   successful
+  # @see #length
   #
   # @version SketchUp 8.0 M2
   def size

data/SketchUp/Sketchup/InstancePath.rb

@@ -155,14 +155,14 @@ class Sketchup::InstancePath
   def leaf
   end
 
-  # {#length} is and alias of {#size}.
+  # {#length} is an alias of {#size}.
   #
   # @example
   #   model = Sketchup.active_model
   #   group = model.entities.add_group
   #   edge = group.entities.add_line([10, 10, 10], [20, 20, 20])
   #   path = Sketchup::InstancePath.new(group, edge])
-  #   if path.size > 1
+  #   if path.length > 1
   #     # do something
   #   end
   #
@@ -170,6 +170,8 @@ class Sketchup::InstancePath
   #
   # @return [Integer]
   #
+  # @see #size
+  #
   # @version SketchUp 2017
   def length
   end
@@ -213,7 +215,6 @@ class Sketchup::InstancePath
   def root
   end
 
-  # {#length} is and alias of {#size}.
   #
   # @example
   #   model = Sketchup.active_model
@@ -228,6 +229,8 @@ class Sketchup::InstancePath
   #
   # @return [Integer]
   #
+  # @see #length
+  #
   # @version SketchUp 2017
   def size
   end

data/SketchUp/Sketchup/Layers.rb

@@ -17,9 +17,7 @@ class Sketchup::Layers < Sketchup::Entity
 
   # Instance Methods
 
-  # The [] method is used to retrieve a layer by index or name.
-  #
-  # The {#at} method is an alias for {#[]}.
+  # The {#[]} method is used to retrieve a layer by index or name.
   #
   # @example
   #   model = Sketchup.active_model
@@ -28,11 +26,13 @@ class Sketchup::Layers < Sketchup::Entity
   #   layer_by_number = layers[1]
   #   layer_by_name = layers["test layer"]
   #
-  # @param index_or_name
-  #   A number representing the layer's index in an array of
-  #   Layer objects, or the name of the layer.
+  # @param [Integer, String] index_or_name
+  #   A number representing the layer's
+  #   index in an array of Layer objects, or the name of the layer.
   #
-  # @return layer - a Layer object
+  # @return [Sketchup::Layer, nil]
+  #
+  # @see #at
   #
   # @version SketchUp 6.0
   def [](index_or_name)
@@ -71,22 +71,18 @@ class Sketchup::Layers < Sketchup::Entity
   def add_observer(observer)
   end
 
-  # The [] method is used to retrieve a layer by index or name.
-  #
   # The {#at} method is an alias for {#[]}.
   #
   # @example
   #   model = Sketchup.active_model
   #   layers = model.layers
   #   new_layer = layers.add "test layer"
-  #   layer_by_number = layers[1]
-  #   layer_by_name = layers["test layer"]
+  #   layer_by_number = layers.at(1)
+  #   layer_by_name = layers.at("test layer")
   #
-  # @param index_or_name
-  #   A number representing the layer's index in an array of
-  #   Layer objects, or the name of the layer.
+  # @return [Sketchup::Layer, nil]
   #
-  # @return layer - a Layer object
+  # @see #[]
   #
   # @version SketchUp 6.0
   def at(index_or_name)
@@ -125,13 +121,13 @@ class Sketchup::Layers < Sketchup::Entity
 
   # The {#length} method retrieves the number of layers.
   #
-  # The {#size} method is an alias for {#length} added in SketchUp 2014.
-  #
   # @example
   #   layers = Sketchup.active_model.layers
   #   number = layers.length
   #
-  # @return integer - the number of layers in the collection
+  # @return [Integer]
+  #
+  # @see #size
   #
   # @version SketchUp 6.0
   def length
@@ -198,17 +194,17 @@ class Sketchup::Layers < Sketchup::Entity
   def remove_observer(observer)
   end
 
-  # The {#length} method retrieves the number of layers.
-  #
-  # The {#size} method is an alias for {#length} added in SketchUp 2014.
+  # The {#size} method is an alias of {#length}.
   #
   # @example
   #   layers = Sketchup.active_model.layers
-  #   number = layers.length
+  #   number = layers.size
   #
-  # @return integer - the number of layers in the collection
+  # @return [Integer]
   #
-  # @version SketchUp 6.0
+  # @see #length
+  #
+  # @version SketchUp 2014
   def size
   end
 

data/SketchUp/Sketchup/Licensing.rb

@@ -1,14 +1,16 @@
 # Copyright:: Copyright 2017 Trimble Inc.
 # License:: The MIT License (MIT)
 
-# The Sketchup::Licensing module contains methods for extensions purchased
-# from Extension Warehouse to check their licensing status. It is advised
-# to place these calls inside encrypted Ruby (.rbe) files. This API is also
-# exposed via the SketchUp C API. Extensions that already use native code
-# should prefer using the native API, which should be more secure than their
-# Ruby API counterparts.
+# The +Sketchup::Licensing+ module contains methods for
+# extensions purchased from Extension Warehouse to check their licensing status.
 #
-# See the {Licensing Tutorial}[../tutorial_licensing] for more details.
+# It is advised to place these calls inside encrypted Ruby (.rbe) files. This
+# API is also exposed via the SketchUp C API. Extensions that already use
+# native code should prefer using the native API, which should be more secure
+# than their Ruby API counterparts.
+#
+# For more details, see:
+# {Developer Center Licensing Tutorial}[https://extensions.sketchup.com/en/developer_center/tutorial_licensing]
 #
 # @version SketchUp 2015
 module Sketchup::Licensing
@@ -32,13 +34,12 @@ module Sketchup::Licensing
   #      puts "Extension is licensed."
   #   end
   #
-  # @param extension_id
-  #   String - The Extension Warehouse UUID for the extension.
+  # @param [String] extension_id
+  #   The Extension Warehouse UUID for the desired extension.
   #
-  # @return ExtensionLicense - an object representing licensing
-  #   state for the extension. Do not store this object,
-  #   retrieve it again when needed since licensing state may
-  #   have changed.
+  # @return [ExtensionLicense] An object representing
+  #   licensing state for the extension. Do not store this object, retrieve
+  #   it again when needed since licensing state may have changed.
   #
   # @version SketchUp 2015
   def self.get_extension_license(extension_id)

data/SketchUp/Sketchup/Materials.rb

@@ -111,7 +111,7 @@ class Sketchup::Materials < Sketchup::Entity
   #   +Enumable+ mix-in module. Prior to that the {#count} method is an alias
   #   for {#length}.
   #
-  # @return integer - number of materials in the collection.
+  # @return [Integer]
   #
   # @see #length
   #
@@ -166,13 +166,13 @@ class Sketchup::Materials < Sketchup::Entity
 
   # The number of materials in the collection.
   #
-  # The {#size} method is an alias for {#length} added in SketchUp 2014.
-  #
   # @example
   #   materials = Sketchup.active_model.materials
   #   number = materials.length
   #
-  # @return integer - number of materials in the collection.
+  # @return [Integer]
+  #
+  # @see #size
   #
   # @version SketchUp 6.0
   def length
@@ -268,15 +268,17 @@ class Sketchup::Materials < Sketchup::Entity
 
   # The number of materials in the collection.
   #
-  # The {#size} method is an alias for {#length} added in SketchUp 2014.
+  # The {#size} method is an alias for {#length}.
   #
   # @example
   #   materials = Sketchup.active_model.materials
-  #   number = materials.length
+  #   number = materials.size
   #
-  # @return integer - number of materials in the collection.
+  # @return [Integer]
   #
-  # @version SketchUp 6.0
+  # @see #length
+  #
+  # @version SketchUp 2014
   def size
   end
 

data/SketchUp/Sketchup/Menu.rb

@@ -8,7 +8,7 @@ class Sketchup::Menu
 
   # Instance Methods
 
-  # The add_item menu item is used to add a menu item to the specified menu.
+  # The {#add_item} method is used to add a menu item to the specified menu.
   #
   # This method takes a block that defines the action to perform when the menu
   # item is selected.
@@ -17,24 +17,22 @@ class Sketchup::Menu
   # validation procedure for the menu item.
   #
   # @example
-  #   plugins_menu = UI.menu("Plugins")
-  #   item = plugins_menu.add_item("Test") { test }
-  #   if (item)
-  #     UI.messagebox item
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   menu = UI.menu('Plugins')
+  #   menu.add_item("Test") { puts 'Hello World' }
   #
-  # @param menu
-  #   A string name of the menu to add.
+  # @overload add_item(menu, &block)
   #
-  # @return item_id - a unique integer id for the added menu item.
+  #   @param [String] menu  The name of the menu to add.
+  #   @yield  A block that will be invoked when the menu item is selected.
+  #   @return [Integer] A unique integer id for the added menu item.
   #
-  # @version SketchUp 6.0
+  # @overload add_item(command)
   #
-  # @yield A method that will be invoked when the menu item is
-  #   selected.
-  def add_item(menu, &block)
+  #   @param [UI::Command] command
+  #   @return [Integer] A unique integer id for the added menu item.
+  #
+  # @version SketchUp 6.0
+  def add_item(*args)
   end
 
   # The add_separator method is used to add a menu separator to a menu.

data/SketchUp/Sketchup/OptionsManager.rb

@@ -100,33 +100,30 @@ class Sketchup::OptionsManager
   def keys
   end
 
-  # The {#size} method returns the number of OptionsProvider objects inside this
-  # OptionsManager.
-  #
-  # The {#length} method is an alias for {#size} added in SketchUp 2014.
+  # The {#length} method is an alias of {#size}.
   #
   # @example
   #   optionsmanager = Sketchup.active_model.options
-  #   number = manager.size
+  #   number = manager.length
   #
-  # @return integer - number of OptionsProvider objects if
-  #   successful
+  # @return [Integer]
   #
-  # @version SketchUp 6.0
+  # @see #size
+  #
+  # @version SketchUp 2014
   def length
   end
 
-  # The {#size} method returns the number of OptionsProvider objects inside this
-  # OptionsManager.
-  #
-  # The {#length} method is an alias for {#size} added in SketchUp 2014.
+  # The {#size} method returns the number of {OptionsProvider} objects inside
+  # this {OptionsManager}.
   #
   # @example
   #   optionsmanager = Sketchup.active_model.options
   #   number = manager.size
   #
-  # @return integer - number of OptionsProvider objects if
-  #   successful
+  # @return [Integer]
+  #
+  # @see #length
   #
   # @version SketchUp 6.0
   def size