sketchup-api-stubs 0.1.2 → 0.2.0

data/SketchUp/{Geom.rb → geom.rb}

@@ -32,6 +32,8 @@ module Geom
   # The {.closest_points} method is used to compute the closest points on two
   # lines.
   #
+  # line.
+  #
   # @example
   #   line1 = [Geom::Point3d.new(0, 2, 0), Geom::Vector3d.new(1, 0, 0)]
   #   line2 = [Geom::Point3d.new(3, 0, 0), Geom::Vector3d.new(0, 1, 0)]
@@ -47,7 +49,7 @@ module Geom
   #   intersect
   #
   # @return [Array(Geom::Point3d, Geom::Point3d)] An array of two points. The
-  #   first point is on the first line and the second point is on the second line.
+  #   first point is on the first line and the second point is on the second
   #
   # @version SketchUp 6.0
   def self.closest_points(line1, line2)
@@ -136,8 +138,8 @@ module Geom
   def self.intersect_line_plane(line, plane)
   end
 
-  # The {.intersect_plane_plane} method is used to compute the intersection of two
-  # planes.
+  # The {.intersect_plane_plane} method is used to compute the intersection of
+  # two planes.
   #
   # @example
   #   # Defines a plane with it's normal parallel to the x axis.
@@ -174,17 +176,17 @@ module Geom
   #
   # @overload linear_combination(weight1, point1, weight2, point2)
   #
-  #   @param [Float] weight1 A weight or percentage.
+  #   @param [Float] weight1
   #   @param [Geom::Point3d] point1
-  #   @param [Float] weight2 A weight or percentage.
+  #   @param [Float] weight2
   #   @param [Geom::Point3d] point2
   #   @return [Geom::Point3d]
   #
   # @overload linear_combination(weight1, vector1, weight2, vector2)
   #
-  #   @param [Float] weight1 A weight or percentage.
+  #   @param [Float] weight1
   #   @param [Geom::Vector3d] vector1
-  #   @param [Float] weight2 A weight or percentage.
+  #   @param [Float] weight2
   #   @param [Geom::Vector3d] vector2
   #   @return [Geom::Vector3d]
   #

data/SketchUp/{LanguageHandler.rb → languagehandler.rb}

@@ -10,10 +10,10 @@
 #
 # @example Example code that uses LanguageHandler:
 #   # Create a global language handler object
-#   swiveldriver_langHandler = LanguageHandler.new('swiveldriver.strings')
+#   swiveldriver_lang_handler = LanguageHandler.new('swiveldriver.strings')
 #
 #   # Get localized string
-#   localizedStr = swiveldriver_langHandler.GetString('String 1')
+#   localizedStr = swiveldriver_lang_handler.GetString('String 1')
 #
 # @example
 #   "String 1"="Localized String 1";
@@ -37,13 +37,13 @@ class LanguageHandler
   # in the Resources folder.
   #
   # @example
-  #   swiveldriver_langHandler = LanguageHandler.new('swiveldriver.strings')
-  #   localized_string = swiveldriver_langHandler['String 1']
+  #   swiveldriver_lang_handler = LanguageHandler.new('swiveldriver.strings')
+  #   localized_string = swiveldriver_lang_handler['String 1']
   #
-  # @param key
+  # @param [String] key
   #   The key for the string to be retrieved.
   #
-  # @return the localized string.
+  # @return [String] the localized string.
   #
   # @version SketchUp 2014
   def [](key)
@@ -52,13 +52,13 @@ class LanguageHandler
   # The new method is used to create a new LanguageHandler object.
   #
   # @example
-  #   swiveldriver_langHandler = LanguageHandler.new('swiveldriver.strings')
+  #   swiveldriver_lang_handler = LanguageHandler.new('swiveldriver.strings')
   #
-  # @param filename
+  # @param [String] filename
   #   The name of the file that contains the localized strings
   #   with their keys in UTF-8 encoding.
   #
-  # @return the new LanguageHandler object
+  # @return [LanguageHandler] the new LanguageHandler object
   #
   # @version SketchUp 2014
   def initialize(filename)
@@ -68,10 +68,10 @@ class LanguageHandler
   # in the Resources folder.
   #
   # @example
-  #   swiveldriver_langHandler = LanguageHandler.new('swiveldriver.strings')
-  #   image = swiveldriver_langHandler.resource_path('fancy_image.png')
+  #   swiveldriver_lang_handler = LanguageHandler.new('swiveldriver.strings')
+  #   image = swiveldriver_lang_handler.resource_path('fancy_image.png')
   #
-  # @return path - the location of the file in the Resources folder.
+  # @return [String] the location of the file in the Resources folder.
   #
   # @version SketchUp 2014
   def resource_path
@@ -80,10 +80,10 @@ class LanguageHandler
   # Returns a Hash object containing the localization dictionary.
   #
   # @example
-  #   swiveldriver_langHandler = LanguageHandler.new('swiveldriver.strings')
-  #   hash = swiveldriver_langHandler.strings
+  #   swiveldriver_lang_handler = LanguageHandler.new('swiveldriver.strings')
+  #   hash = swiveldriver_lang_handler.strings
   #
-  # @return hash - the localization dictionary.
+  # @return [Hash] the localization dictionary.
   #
   # @version SketchUp 2014
   def strings

data/SketchUp/{Length.rb → length.rb}

@@ -47,10 +47,10 @@ class Length < Float
   #     puts "length1 is not less than length2"
   #   end
   #
-  # @param length2
+  # @param [Length] length2
   #   A length value.
   #
-  # @return status - true if length1 is < length2; false if
+  # @return [Boolean] true if length1 is < length2; false if
   #   length1 is not < length2
   #
   # @version SketchUp 6.0
@@ -69,10 +69,10 @@ class Length < Float
   #     puts "length1 is greater than length2"
   #   end
   #
-  # @param length2
+  # @param [Length] length2
   #   A length value.
   #
-  # @return status - true if length1 is <= length2; false if
+  # @return [Boolean] true if length1 is <= length2; false if
   #   length1 is not <= length2
   #
   # @version SketchUp 6.0
@@ -88,10 +88,10 @@ class Length < Float
   #   length2 = 30.to_l
   #   result = length1 <=> length2
   #
-  # @param length2
+  # @param [Length] length2
   #   A length value.
   #
-  # @return result - the result of the comparison
+  # @return [Integer] the result of the comparison
   #
   # @version SketchUp 6.0
   def <=>(length2)
@@ -107,10 +107,10 @@ class Length < Float
   #   length2 = 30.to_l
   #   is_equal = length1 == length2
   #
-  # @param length2
+  # @param [Length] length2
   #   A length value.
   #
-  # @return status - true if length1 is == length2; false if
+  # @return [Boolean] true if length1 is == length2; false if
   #   length1 is not == length2
   #
   # @version SketchUp 6.0
@@ -131,10 +131,10 @@ class Length < Float
   #     puts "length1 is not greater than length2"
   #   end
   #
-  # @param length2
+  # @param [Length] length2
   #   A length value.
   #
-  # @return status - true if length1 is > length2; false if length1
+  # @return [Boolean] true if length1 is > length2; false if length1
   #   is not > length2
   #
   # @version SketchUp 6.0
@@ -156,10 +156,10 @@ class Length < Float
   #     puts "length1 is less than length2"
   #   end
   #
-  # @param length2
+  # @param [Length] length2
   #   A length value.
   #
-  # @return status - true if length1 is >= length2; false if
+  # @return [Boolean] true if length1 is >= length2; false if
   #   length1 is not >= length2
   #
   # @version SketchUp 6.0
@@ -175,7 +175,7 @@ class Length < Float
   #   length = 55.to_l
   #   str = length.inspect
   #
-  # @return length - an unformatted length string
+  # @return [String] an unformatted length string
   #
   # @version SketchUp 6.0
   def inspect
@@ -187,7 +187,7 @@ class Length < Float
   #   length = 45.to_l
   #   f = length.to_f
   #
-  # @return value - the float length value
+  # @return [Float] the float length value
   #
   # @version SketchUp 6.0
   def to_f
@@ -201,7 +201,7 @@ class Length < Float
   #   length = 55.to_l
   #   str = length.to_s
   #
-  # @return value - the float length value
+  # @return [String] the float length value
   #
   # @version SketchUp 6.0
   def to_s

data/SketchUp/{Numeric.rb → numeric.rb}

@@ -15,7 +15,7 @@ class Numeric
   #   cm = 10
   #   inches = cm.cm
   #
-  # @return inches - a value in inches if successful
+  # @return [Length] a value in inches if successful
   #
   # @version SketchUp 6.0
   def cm
@@ -29,7 +29,7 @@ class Numeric
   #   degrees = 90
   #   radians = degrees.degrees
   #
-  # @return radians - a value in radians if successful
+  # @return [Float] a value in radians if successful
   #
   # @version SketchUp 6.0
   def degrees
@@ -41,7 +41,7 @@ class Numeric
   #   feet = 1
   #   inches = feet.feet
   #
-  # @return inches - a value in inches if successful
+  # @return [Length] a value in inches if successful
   #
   # @version SketchUp 6.0
   def feet
@@ -53,7 +53,7 @@ class Numeric
   #   number = 12
   #   length = number.to_l
   #
-  # @return length - a Length object if successful
+  # @return [Length] a Length object if successful
   #
   # @version SketchUp 6.0
   def inch
@@ -65,7 +65,7 @@ class Numeric
   #   value = 1
   #   inches = value.km
   #
-  # @return inches - a value in inches if successful
+  # @return [Length] a value in inches if successful
   #
   # @version SketchUp 6.0
   def km
@@ -77,7 +77,7 @@ class Numeric
   #   meters = 1
   #   inches = meters.m
   #
-  # @return inches - a value in inches if successful
+  # @return [Length] a value in inches if successful
   #
   # @version SketchUp 6.0
   def m
@@ -89,7 +89,7 @@ class Numeric
   #   miles = 1
   #   inches = miles.mile
   #
-  # @return inches - a value in inches if successful
+  # @return [Length] a value in inches if successful
   #
   # @version SketchUp 6.0
   def mile
@@ -104,7 +104,7 @@ class Numeric
   #   value = 10
   #   mm = value.mm
   #
-  # @return mm - a value in millimeters if successful
+  # @return [Length] a value in millimeters if successful
   #
   # @version SketchUp 6.0
   def mm
@@ -118,7 +118,7 @@ class Numeric
   #   radians = 1.5707963267949
   #   degrees = radians.radians
   #
-  # @return degrees - a value in degrees if successful
+  # @return [Float] a value in degrees if successful
   #
   # @version SketchUp 6.0
   def radians
@@ -130,7 +130,7 @@ class Numeric
   #   inches = 1
   #   cm = inches.to_cm
   #
-  # @return cm - a value in centimeters if successful
+  # @return [Float] a value in centimeters if successful
   #
   # @version SketchUp 6.0
   def to_cm
@@ -142,7 +142,7 @@ class Numeric
   #   inches = 12
   #   feet = inches.to_feet
   #
-  # @return feet - a value in feet if successful
+  # @return [Float] a value in feet if successful
   #
   # @version SketchUp 6.0
   def to_feet
@@ -156,7 +156,7 @@ class Numeric
   #   inches = 12
   #   inches = inches.to_inch
   #
-  # @return inches - a value in inches if successful
+  # @return [Float] a value in inches if successful
   #
   # @version SketchUp 6.0
   def to_inch
@@ -168,7 +168,7 @@ class Numeric
   #   inches = 1
   #   km = inches.to_km
   #
-  # @return kilometers - a value in kilometers if successful
+  # @return [Float] a value in kilometers if successful
   #
   # @version SketchUp 6.0
   def to_km
@@ -180,7 +180,7 @@ class Numeric
   #   number = 12
   #   length = number.to_l
   #
-  # @return length - a Length object if successful
+  # @return [Length] a Length object if successful
   #
   # @version SketchUp 6.0
   def to_l
@@ -192,7 +192,7 @@ class Numeric
   #   inches = 12
   #   meters = inches.to_m
   #
-  # @return meters - a value in meters if successful
+  # @return [Float] a value in meters if successful
   #
   # @version SketchUp 6.0
   def to_m
@@ -204,7 +204,7 @@ class Numeric
   #   inches = 10000
   #   miles = inches.to_mile
   #
-  # @return miles - a value in miles if successful
+  # @return [Float] a value in miles if successful
   #
   # @version SketchUp 6.0
   def to_mile
@@ -216,7 +216,7 @@ class Numeric
   #   inches = 1
   #   mm = inches.to_mm
   #
-  # @return millimeters - a value in millimeters if successful
+  # @return [Float] a value in millimeters if successful
   #
   # @version SketchUp 6.0
   def to_mm
@@ -228,7 +228,7 @@ class Numeric
   #   inches = 10000
   #   yards = inches.to_yard
   #
-  # @return yards - a value in yards if successful
+  # @return [Float] a value in yards if successful
   #
   # @version SketchUp 6.0
   def to_yard
@@ -240,7 +240,7 @@ class Numeric
   #   yards = 1.to_l
   #   inches = yards.yard
   #
-  # @return inches - a value in inches if successful
+  # @return [Length] a value in inches if successful
   #
   # @version SketchUp 6.0
   def yard

data/SketchUp/sketchup.rb

@@ -42,13 +42,13 @@ module Sketchup
   #
   # @example
   #   model = Sketchup.active_model
-  #   if (! model)
-  #     UI.messagebox "Failure"
+  #   if !model
+  #     UI.messagebox("Failure")
   #   else
   #     # code acting on the model
   #   end
   #
-  # @return [Sketchup::Model] model - active model object if successful, false if
+  # @return [Sketchup::Model] active model object if successful, false if
   #   unsuccessful
   #
   # @version SketchUp 6.0
@@ -58,12 +58,12 @@ module Sketchup
   # The add_observer method is used to add an observer to the current object.
   #
   # @example
-  #   status = Sketchup.add_observer observer
+  #   status = Sketchup.add_observer(observer)
   #
-  # @param observer
+  # @param [Object] observer
   #   An observer.
   #
-  # @return status - true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def self.add_observer(observer)
@@ -74,7 +74,7 @@ module Sketchup
   # @example
   #   name = Sketchup.app_name
   #
-  # @return name - the name of the application, either
+  # @return [String] the name of the application, either
   #   "SketchUp Pro" or "SketchUp".
   #   Note: For versions earlier than SketchUp8 M4
   #   (Mac 8.0.15157 and Windows 8.0.15158) this function will
@@ -95,13 +95,13 @@ module Sketchup
   # reactivated.
   #
   # @example
-  #   is_on = Sketchup.break_edges?
+  #   Sketchup.break_edges = false
   #
-  # @param enabled
+  # @param [Boolean] enabled
   #   If true, break edges will be turned on. If false, it
   #   will be deactivated.
   #
-  # @return setting - true if break edges was turned on.
+  # @return [Boolean] true if break edges was turned on.
   #
   # @version SketchUp 7.0
   def self.break_edges=(enabled)
@@ -116,7 +116,7 @@ module Sketchup
   # @example
   #   is_on = Sketchup.break_edges?
   #
-  # @return break_edges - true if the feature is on.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -129,7 +129,7 @@ module Sketchup
   # @example
   #   texturewriter = Sketchup.create_texture_writer
   #
-  # @return texturewriter - a texturewriter object if successful.
+  # @return [Sketchup::TextureWriter] a texturewriter object if successful.
   #
   # @version SketchUp 6.0
   def self.create_texture_writer
@@ -142,10 +142,10 @@ module Sketchup
   # @example
   #   Sketchup.debug_mode = true
   #
-  # @param enabled
+  # @param [Boolean] enabled
   #   If true, SketchUp will produce debug warnings.
   #
-  # @return setting - true if debug mode is enabled.
+  # @return [Boolean]
   #
   # @version SketchUp 2016
   def self.debug_mode=(enabled)
@@ -157,7 +157,7 @@ module Sketchup
   # @example
   #   debug_mode = Sketchup.debug_mode?
   #
-  # @return debug_mode - true if debug mode is enabled
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -174,10 +174,10 @@ module Sketchup
   #
   # @note This method has been non-functional on Mac since SketchUp 8.
   #
-  # @param action_name
+  # @param [String] action_name
   #   An action string.
   #
-  # @return friendly_name = a friendly name.
+  # @return [String] a friendly name.
   #
   # @version SketchUp 6.0
   def self.display_name_from_action(action_name)
@@ -188,12 +188,11 @@ module Sketchup
   #
   # @example
   #   extensions = Sketchup.extensions
-  #   for extension in extensions
-  #     UI.messagebox('The next extension is named: ' + extension.name +
-  #         ' and its loaded? state is: ' + extension.loaded?)
-  #   end
+  #   extensions.each{ |extension|
+  #     puts "The next extension is named: #{extension.name} and its loaded? state is: #{extension.loaded?}"
+  #   }
   #
-  # @return extensionsmanager - an ExtensionsManager object.
+  # @return [Sketchup::ExtensionsManager] an ExtensionsManager object.
   #
   # @version SketchUp 8.0 M2
   def self.extensions
@@ -204,7 +203,7 @@ module Sketchup
   # @example
   #   new_sketchup = Sketchup.file_new
   #
-  # @return Sketchup - a Sketchup object if successful.
+  # @return [Module] The Sketchup module.
   #
   # @version SketchUp 6.0
   def self.file_new
@@ -216,29 +215,29 @@ module Sketchup
   # Forward slashes must be used to delimit between directory names.
   #
   # @example
-  #   help_file = Sketchup.find_support_file "help.html", "Plugins/"
-  #   if (help_file)
+  #   help_file = Sketchup.find_support_file("help.html", "Plugins/")
+  #   if help_file
   #     # Print out the help_file full path
-  #     UI.messagebox help_file
+  #     UI.messagebox(help_file)
   #
   #     # Open the help_file in a web browser
-  #     UI.openURL "file://" + help_file
+  #     UI.openURL("file://" + help_file)
   #   else
-  #     UI.messagebox "Failure"
+  #     UI.messagebox("Failure")
   #   end
   #
-  # @param filename
+  # @param [String] filename
   #   Name of the filename you want to find.
   #
-  # @param directory
+  # @param [String] directory
   #   directory relative to the SketchUp
   #   installation directory.
   #
-  # @return path - the entire path if successful. If unsuccessful,
+  # @return [String] the entire path if successful. If unsuccessful,
   #   the method returns false.
   #
   # @version SketchUp 6.0
-  def self.find_support_file(filename, directory = '')
+  def self.find_support_file(filename, directory)
   end
 
   # The find_support_files method is used to retrieve the path and name of all
@@ -249,15 +248,15 @@ module Sketchup
   # @example
   #   files = Sketchup.find_support_files('rb', 'Plugins')
   #
-  # @param filename
+  # @param [String] filename
   #   Extension of the files to be found.
   #
-  # @param directory
+  # @param [String] directory
   #   directory relative to the SketchUp installation
   #   directory. Without this the result will
   #   be empty.
   #
-  # @return array - an array of files. If unsuccessful, the method
+  # @return [Array<String>] an array of files. If unsuccessful, the method
   #   returns false.
   #
   # @version SketchUp 6.0
@@ -270,13 +269,13 @@ module Sketchup
   # method can be used to control it.
   #
   # @example
-  #   Sketchup.fix_shadow_strings=true
+  #   Sketchup.fix_shadow_strings = true
   #
-  # @param enabled
+  # @param [Boolean] enabled
   #   If true, shadow strings fix will be turned on. If
   #   false, it will be deactivated.
   #
-  # @return setting - true if shadow strings fix was turned on.
+  # @return [Boolean] true if shadow strings fix was turned on.
   #
   # @version SketchUp 8.0 M1
   def self.fix_shadow_strings=(enabled)
@@ -290,7 +289,7 @@ module Sketchup
   # @example
   #   is_on = Sketchup.fix_shadow_strings?
   #
-  # @return fix_shadow_strings - true if the feature is on.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -302,13 +301,12 @@ module Sketchup
   # into degrees. For example, format_angle(Math::PI) will return 180.0.
   #
   # @example
-  #   degrees = Sketchup.format_angle Math::PI
+  #   degrees = Sketchup.format_angle(Math::PI)
   #
-  # @param number
+  # @param [Numeric] number
   #   A number to be formatted.
   #
-  # @return degrees - an angle in degrees if successful, false if
-  #   unsuccessful
+  # @return [String] an angle in degrees if successful, false if unsuccessful
   #
   # @version SketchUp 6.0
   def self.format_angle(number)
@@ -321,12 +319,12 @@ module Sketchup
   # squared.
   #
   # @example
-  #   area = Sketchup.format_area number
+  #   area = Sketchup.format_area(number)
   #
-  # @param number
+  # @param [Numeric] number
   #   A number to be formatted.
   #
-  # @return area - an area if successful, false if unsuccessful.
+  # @return [String] an area if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def self.format_area(number)
@@ -336,12 +334,12 @@ module Sketchup
   # example, 10 becomes 10.0. This is the equivalent to a to_f call.
   #
   # @example
-  #   degrees = Sketchup.format_degrees number
+  #   degrees = Sketchup.format_degrees(number)
   #
-  # @param number
+  # @param [Numeric] number
   #   A number to be formatted.
   #
-  # @return degrees - degrees if successful, false if unsuccessful.
+  # @return [String] degrees if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def self.format_degrees(number)
@@ -353,15 +351,15 @@ module Sketchup
   # The default unit setting is inches. For example, 10 becomes 10".
   #
   # @example
-  #   length = Sketchup.format_length 10
-  #   if (length)
-  #     UI.messagebox length
+  #   length = Sketchup.format_length(10)
+  #   if length
+  #     UI.messagebox(length)
   #   end
   #
-  # @param number
+  # @param [Numeric] number
   #   A number to be formatted.
   #
-  # @return length - length if successful, false if unsuccessful
+  # @return [String] length if successful, false if unsuccessful
   #
   # @version SketchUp 6.0
   def self.format_length(number)
@@ -375,14 +373,14 @@ module Sketchup
   # @example
   #   value = Sketchup.get_datfile_info(key, default_value)
   #
-  # @param key
+  # @param [String] key
   #   The key whose value you want to retrieve.
   #
-  # @param default_value
+  # @param [String] default_value
   #   The default value you want returned if key is not
   #   available.
   #
-  # @return value - a string value if successful.
+  # @return [String] a string value if successful.
   #
   # @version SketchUp 6.0
   def self.get_datfile_info(key, default_value)
@@ -397,14 +395,14 @@ module Sketchup
   # @example
   #   value = Sketchup.get_i18ndatfile_info(key, default_value)
   #
-  # @param key
+  # @param [String] key
   #   The key whose value you want to retrieve.
   #
-  # @param default_value
+  # @param [String] default_value
   #   The default value you want returned if key is not
   #   available.
   #
-  # @return value - a string value if successful.
+  # @return [String] a string value if successful.
   #
   # @version SketchUp 6.0
   def self.get_i18n_datfile_info(key, default_value)
@@ -421,7 +419,7 @@ module Sketchup
   # @example
   #   language = Sketchup.os_language
   #
-  # @return language - a code representing the language SketchUp
+  # @return [String] a code representing the language SketchUp
   #   is displaying.
   #
   # @version SketchUp 6.0
@@ -433,13 +431,12 @@ module Sketchup
   # localization files.
   #
   # @example
-  #   directory = Sketchup.get_resource_path "Styles.strings"
+  #   directory = Sketchup.get_resource_path("Styles.strings")
   #
-  # @param filename
-  #   The filename of a resource file in the resource
-  #   directory hierarchy.
+  # @param [String] filename
+  #   The filename of a resource file in the resource directory hierarchy.
   #
-  # @return path - the directory path to the resources folder.
+  # @return [String] the directory path to the resources folder.
   #
   # @version SketchUp 6.0
   def self.get_resource_path(filename)
@@ -453,7 +450,7 @@ module Sketchup
   # @example
   #   shortcuts = Sketchup.get_shortcuts
   #
-  # @return shortcuts - an array of shortcut strings.
+  # @return [Array<String>] an array of shortcut strings.
   #
   # @version SketchUp 6.0
   def self.get_shortcuts
@@ -484,21 +481,21 @@ module Sketchup
   #   begin
   #     Sketchup.install_from_archive(path)
   #   rescue Interrupt => error
-  #     UI.messagebox "User said 'no': " + error
+  #     UI.messagebox("User said 'no': " + error)
   #   rescue Exception => error
-  #     UI.messagebox "Error during unzip: " + error
+  #     UI.messagebox("Error during unzip: " + error)
   #   end
   #
   # @param [String] filename
   #   The path to the RBZ or ZIP file to install.
   #
-  # @raise [Exception] If the archive cannot be found.
+  # @raise [Exception] If the archive cannot be installed.
   #
   # @raise [Interrupt] If the user cancel the installation.
   #
-  # @raise [Exception] If the archive cannot be installed.
+  # @raise [Exception] If the archive cannot be found.
   #
-  # @return [Boolean] .
+  # @return [Boolean]
   #
   # @version SketchUp 8.0 M2
   def self.install_from_archive(filename)
@@ -518,7 +515,7 @@ module Sketchup
   #     # Load 32bit binaries.
   #   end
   #
-  # @return Boolean - True if SketchUp is 64bit.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -533,7 +530,7 @@ module Sketchup
   # @example
   #   status = Sketchup.is_online
   #
-  # @return status - true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def self.is_online
@@ -545,11 +542,11 @@ module Sketchup
   # the product.
   #
   # @example
-  #   if (Sketchup.is_pro?)
-  #     UI.messagebox "You are running SU Pro."
+  #   if Sketchup.is_pro?
+  #     UI.messagebox("You are running SU Pro.")
   #   end
   #
-  # @return is_pro - true if the user is using SketchUp Pro
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -561,13 +558,12 @@ module Sketchup
   # contains illegal characters.
   #
   # @example
-  #   status = Sketchup.is_valid_filename? filename
+  #   status = Sketchup.is_valid_filename?(filename)
   #
-  # @param filename
+  # @param [String] filename
   #   A filename string.
   #
-  # @return status - true if filename is valid, false if filename
-  #   is invalid (contains illegal characters).
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -586,11 +582,11 @@ module Sketchup
   #   sfile = "application_loader" # file extension not required
   #   status = Sketchup.load(sfile)
   #
-  # @param path
+  # @param [String] path
   #   The path, including the filename, to the file you want
   #   to require.
   #
-  # @return status - True if the file is included. False if the
+  # @return [Boolean] True if the file is included. False if the
   #   file is not included.
   #
   # @version SketchUp 6.0
@@ -600,12 +596,12 @@ module Sketchup
   # The open_file method is used to open a file.
   #
   # @example
-  #   result = Sketchup.open_file "C:\\model.skp"
+  #   result = Sketchup.open_file("C:\\model.skp")
   #
-  # @param filename
+  # @param [String] filename
   #   The path and filename to open.
   #
-  # @return result - true if opening the file succeeded,
+  # @return [Boolean] true if opening the file succeeded,
   #   false otherwise.
   #
   # @version SketchUp 6.0
@@ -623,7 +619,7 @@ module Sketchup
   # @example
   #   language = Sketchup.os_language
   #
-  # @return language - a code representing the language SketchUp
+  # @return [String] a code representing the language SketchUp
   #   is displaying.
   #
   # @version SketchUp 6.0
@@ -638,10 +634,10 @@ module Sketchup
   #   float = Sketchup.parse_length("2'") # Returns 24 (representing inches)
   #   length = float.to_l # Convert to a Length type if needed.
   #
-  # @param string
+  # @param [String] string
   #   The string to be parsed as a number.
   #
-  # @return float - the numerical representation of the string if
+  # @return [Float] the numerical representation of the string if
   #   successful, or nil if unsuccessful.
   #
   # @version SketchUp 6.0
@@ -667,7 +663,7 @@ module Sketchup
   #     IS_OSX = Sketchup.platform == :platform_osx
   #   end
   #
-  # @return symbol - Current OS platform.
+  # @return [Symbol] Current OS platform.
   #
   # @version SketchUp 2014
   def self.platform
@@ -682,15 +678,15 @@ module Sketchup
   #
   # @example
   #   # Type this in the Ruby console then restart SketchUp.
-  #   Sketchup.plugins_disabled=true
+  #   Sketchup.plugins_disabled = true
   #
   #   # To reactivate plugins, type this into the Ruby console and restart.
-  #   Sketchup.plugins_disabled=false
+  #   Sketchup.plugins_disabled = false
   #
-  # @param enabled
+  # @param [Boolean] enabled
   #   If true, the plugins directory will not load.
   #
-  # @return setting - true if plugins were disabled.
+  # @return [Boolean] true if plugins were disabled.
   #
   # @version SketchUp 8.0 M2
   def self.plugins_disabled=(enabled)
@@ -702,7 +698,7 @@ module Sketchup
   # @example
   #   is_disabled = Sketchup.plugins_disabled?
   #
-  # @return plugins_disabled - true if the plugins are disabled.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -725,23 +721,22 @@ module Sketchup
   end
 
   # The read_default method is used to retrieve the string associated with a
-  # value within the specified sub-section section of a .INI file or registry
-  # (within the Software > SketchUp > SketchUp [Version] section).
+  # value within the specified sub-section section of a .INI file or registry
+  # (within the Software > SketchUp > SketchUp [Version] section).
   #
   # @example
-  #   result = Sketchup.read_default "section",
-  #   "variable", "default"
-  #
-  # @param section
-  #   A section in an .INI or registry.
+  #   result = Sketchup.read_default("section", "variable", "default")
   #
-  # @param variable
-  #   A variable within the section.
+  # @param [String] section
+  #   A section in an .INI or registry.
   #
-  # @param default
+  # @param [Object] default
   #   A default value if the value is not found.
   #
-  # @return result - nil if unsuccessful, the value of the default
+  # @param [String] variable
+  #   A variable within the section.
+  #
+  # @return [Object, nil] if unsuccessful, the value of the default
   #   if successful.
   #
   # @version SketchUp 6.0
@@ -752,27 +747,27 @@ module Sketchup
   # SketchUp's extension manager (in SketchUp preferences).
   #
   # @example
-  #   utilitiesExtension = SketchupExtension.new "Utilities Tools",
-  #     "Utilities/utilitiesTools.rb"
+  #   utilities_extension = SketchupExtension.new("Utilities Tools",
+  #     "Utilities/utilitiesTools.rb")
   #
-  #   utilitiesExtension.description = "Adds Tools->Utilities to the " +
+  #   utilities_extension.description = "Adds Tools->Utilities to the " +
   #     "SketchUp inteface. The Utilities submenu contains two tools: " +
   #     "Create Face and Query Tool."
   #
-  #   Sketchup.register_extension utilitiesExtension, false
+  #   Sketchup.register_extension(utilities_extension, false)
   #
   # @note It is recommended to set +load_on_start+ to true unless you have a very
   #   good reason not to.
   #
+  # @param [SketchupExtension] extension
+  #   A SketchupExtension object.
+  #
   # @param [Boolean] load_on_start
   #   Passing true into this will load the
   #   extension immediately and set it so
   #   that it will load automatically
   #   whenever SketchUp restarts.
   #
-  # @param [SketchupExtension] extension
-  #   A SketchupExtension object.
-  #
   # @return [Boolean] +true+ if extension registered properly
   #
   # @version SketchUp 6.0
@@ -782,12 +777,12 @@ module Sketchup
   # The register_importer method is used to register an importer with SketchUp.
   #
   # @example
-  #   status = Sketchup.register_importer importer
+  #   status = Sketchup.register_importer(importer)
   #
-  # @param importer
+  # @param [Sketchup::Importer] importer
   #   An Importer object representing the importer.
   #
-  # @return status - true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def self.register_importer(importer)
@@ -797,12 +792,12 @@ module Sketchup
   # object.
   #
   # @example
-  #   status = Sketchup.remove_observer observer
+  #   status = Sketchup.remove_observer(observer)
   #
-  # @param observer
+  # @param [Sketchup::AppObserver] observer
   #   An observer.
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def self.remove_observer(observer)
@@ -821,11 +816,11 @@ module Sketchup
   #   sfile = "application_loader" # file extension not required
   #   status = Sketchup::require(sfile)
   #
-  # @param path
+  # @param [String] path
   #   The path, including the filename, to the file you want
   #   to require.
   #
-  # @return status - True if the file is included. False if the
+  # @return [Boolean] True if the file is included. False if the
   #   file is not included.
   #
   # @version SketchUp 6.0
@@ -836,16 +831,16 @@ module Sketchup
   # not necessarily the loaded model.
   #
   # @example
-  #   status = Sketchup.save_thumbnail "skp_filename", "image_filename"
+  #   status = Sketchup.save_thumbnail("skp_filename", "image_filename")
   #
-  # @param skp_filename
+  # @param [String] skp_filename
   #   The name of the SketchUp file whose model you want
   #   represented in the thumbnail.
   #
-  # @param img_filename
+  # @param [String] img_filename
   #   The name of the file where the thumbnail will be saved.
   #
-  # @return status - true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def self.save_thumbnail(skp_filename, img_filename)
@@ -1058,17 +1053,33 @@ module Sketchup
   # - 21560 and up: causes a runtime Error
   #
   # @example
-  #   result = Sketchup.send_action "selectArcTool:"
+  #   result = Sketchup.send_action("selectArcTool:")
   #
   # @param [String, Integer] action
   #   The action to be performed.
   #
-  # @return [boolean] +true+ if successful, +false+ if unsuccessful
+  # @return [Boolean] +true+ if successful, +false+ if unsuccessful
   #
   # @version SketchUp 6.0
   def self.send_action(action)
   end
 
+  # The {#send_to_layout} method is used to open a file in LayOut.
+  #
+  # @example
+  #   result = Sketchup.send_to_layout("C:/models/hexaflexagon.layout")
+  #
+  # @param [String] file
+  #   The path and filename to open, either .skp or .layout.
+  #
+  # @return [Boolean] true if opening the file succeeded,
+  #   false otherwise.  If LayOut is not installed or the file is not present
+  #   this function will return false.
+  #
+  # @version SketchUp 2018
+  def self.send_to_layout(file)
+  end
+
   # The set_status_text method is used to
   # set the text appearing on the status bar within the drawing window.
   #
@@ -1080,8 +1091,8 @@ module Sketchup
   # - +SB_VCB_VALUE+ - the text will appear in the VCB
   #
   # @example
-  #   result = Sketchup.set_status_text "This is a Test", SB_VCB_VALUE
-  #   if (result)
+  #   result = Sketchup.set_status_text("This is a Test", SB_VCB_VALUE)
+  #   if result
   #     #code to do something if set_status_text is successful
   #   end
   #
@@ -1092,8 +1103,8 @@ module Sketchup
   #
   # @overload set_status_text(status_text = '', position = SB_PROMPT)
   #
-  #   @param status text   the status text that will appear.
-  #   @param position      the position where the text will appear.
+  #   @param [String]  status text the status text that will appear.
+  #   @param [Integer] position    the position where the text will appear.
   #   @return [nil]
   #
   # @version SketchUp 6.0
@@ -1109,10 +1120,10 @@ module Sketchup
   # @example
   #   result = Sketchup.status_text = "This is a Test"
   #
-  # @param status_text
+  # @param [String] status_text
   #   The status text that will appear.
   #
-  # @return result - true if successful, false if unsuccessful.
+  # @return [String]
   #
   # @version SketchUp 6.0
   def self.status_text=(status_text)
@@ -1125,7 +1136,7 @@ module Sketchup
   # @example
   #   temp_dir = Sketchup.temp_dir
   #
-  # @return String containing the full temporary directory path
+  # @return [String] a string containing the full temporary directory path
   #
   # @version SketchUp 2014
   def self.temp_dir
@@ -1137,7 +1148,7 @@ module Sketchup
   # @example
   #   name = Sketchup.template
   #
-  # @return name - the current template
+  # @return [String] the current template
   #
   # @version SketchUp 6.0
   def self.template
@@ -1147,12 +1158,12 @@ module Sketchup
   # Templates are the .skp files that are loaded when the user select File > New.
   #
   # @example
-  #   status = Sketchup.template= "filename"
+  #   status = Sketchup.template = "filename"
   #
-  # @param filename
+  # @param [String] filename
   #   The name of the template to set.
   #
-  # @return status - true if successful, false if unsuccessful.
+  # @return [String] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def self.template=(filename)
@@ -1165,7 +1176,7 @@ module Sketchup
   # @example
   #   directory = Sketchup.template_dir
   #
-  # @return String containing the full template directory path
+  # @return [String] containing the full template directory path
   #
   # @version SketchUp 6.0
   def self.template_dir
@@ -1176,7 +1187,7 @@ module Sketchup
   # @example
   #   Sketchup.undo
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def self.undo
@@ -1192,10 +1203,10 @@ module Sketchup
   # @example
   #   result = Sketchup.vcb_label = "This is a Test"
   #
-  # @param label_text
+  # @param [String] label_text
   #   The label text that will appear.
   #
-  # @return result - true if successful, false if unsuccessful.
+  # @return [String]
   #
   # @version SketchUp 6.0
   def self.vcb_label=(label_text)
@@ -1211,10 +1222,10 @@ module Sketchup
   # @example
   #   result = Sketchup.vcb_value = "This is a Test"
   #
-  # @param value
+  # @param [String] value
   #   The text that will appear as the vcb's value.
   #
-  # @return result - true if successful, false if unsuccessful.
+  # @return [String]
   #
   # @version SketchUp 6.0
   def self.vcb_value=(value)
@@ -1230,7 +1241,7 @@ module Sketchup
   #     return
   #   end
   #
-  # @return version - the decimal form of the version
+  # @return [String] the decimal form of the version
   #
   # @version SketchUp 6.0
   def self.version
@@ -1257,31 +1268,31 @@ module Sketchup
   #     puts "New format"
   #   end
   #
-  # @return version - the whole number form of the version
+  # @return [Integer] the whole number form of the version
   #
   # @version SketchUp 6.0
-  def self.version_number
+  def self.version_number(*args)
   end
 
   # The write_default method is used to set the string associated with a
-  # variable within the specified sub-section of a .plist file on the Mac
-  # or the registry on Windows
-  # (within the Software > SketchUp > SketchUp [Version] section).
+  # variable within the specified sub-section of a .plist file on the Mac
+  # or the registry on Windows
+  # (within the Software > SketchUp > SketchUp [Version] section).
   #
   # @example
   #   result = Sketchup.write_default("section", "key", "my_value")
   #
   # @param [String] section
-  #   A section in a .plist file (Mac) or the registry
-  #   (Windows).
-  #
-  # @param [String] key
-  #   A key within the section.
+  #   A section in a .plist file (Mac) or the registry
+  #   (Windows).
   #
   # @param [Object] value
   #   The value to store.
   #
-  # @return [Boolean] result - True if successful, false if unsuccessful.
+  # @param [String] key
+  #   A key within the section.
+  #
+  # @return [Boolean] True if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def self.write_default(section, key, value)