sketchup-api-stubs 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26637fb494dcc7f44b4445e237bbf28a252bfdf5
-  data.tar.gz: a67eeba59e499c9235d43efbcc465fe02e50f956
+  metadata.gz: 971d247dca78409c1ad07c0ac8b617950e0f45fd
+  data.tar.gz: 1c357742608d50bc22df3031164b08589fa2f34c
 SHA512:
-  metadata.gz: 0ec84ecbee17a6d05970cb9f6a7f322a58ab6109fedd91cf6d2cdd68bd01f4133dd795f0ae1043add96f83022edbcd58f7ad487987a07d8df5d94e3bcb6d9b70
-  data.tar.gz: 878cd1af89b83c621221cee370737ff18ca5a3c24240434293f421fb65164bc43fdb42d2c788a47f43a4b9274ac47c189e1350fa672ab7022095a3450a2af9cd
+  metadata.gz: 17b8031751feab019808184440b8de1622d7afc79e24970ae281863588f857bb027e8038a3f7fa1e930d8e081b643bbaee58e223d273026c3a797eda07da8442
+  data.tar.gz: dba9df82eba6d586d3ddbc40c2d250a08e678ce255ce18aa047491b90d19a4ccca4a5ab23f1434e46717f48f9e84c04bc9c99f0cde1efffedddc983b5742d58f

data/SketchUp/Sketchup/Style.rb

@@ -6,69 +6,61 @@
 # draw the model.
 #
 # @example
-#   # Get a handle to the styles collection.
 #   styles = Sketchup.active_model.styles
-#
-#   # Display the name of the first style.
-#   first_style = styles[0]
-#   UI.messagebox("Your first style is named " + first_style.name.to_s)
+#   puts "Your first style is named #{styles.first.name}"
 #
 # @version SketchUp 6.0
 class Sketchup::Style < Sketchup::Entity
 
   # Instance Methods
 
-  # The description method is used to retrieve the description for a style.
+  # The {#description} method gets the description for a {Sketchup::Style}.
   #
   # @example
-  #   style = Sketchup.active_model.styles[0]
-  #   UI.messagebox("Your first style description is: " +
-  #                 style.description.to_s)
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
+  #   puts "Your first style description is: #{style.description}"
   #
-  # @return description - the description for the style.
+  # @return [String] description
   #
   # @version SketchUp 6.0
   def description
   end
 
-  # The description= method is used to set a description for a style.
+  # The {#description=} method sets the description for a {Sketchup::Style}.
   #
   # @example
-  #   style = Sketchup.active_model.styles[0]
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
   #   style.description = "My new style description."
-  #   UI.messagebox('My new style description is: ' + style.description)
-  #
-  # @param description
-  #   A textual description of the style.
   #
-  # @return status - true if successful, false if unsuccessful.
+  # @param [String] description
   #
   # @version SketchUp 6.0
   def description=(description)
   end
 
-  # The name method is used to retrieve the name for a style.
+  # The {#name} method gets the name for a {Sketchup::Style}.
   #
   # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
   #   name = style.name
   #
-  # @return name - the name for the style.
+  # @return [String]
   #
   # @version SketchUp 6.0
   def name
   end
 
-  # The name= method is used to set the name for a style.
+  # The {#name=} method sets the name for a {Sketchup::Style}.
   #
   # @example
-  #   style = Sketchup.active_model.styles[0]
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
   #   style.name = 'My Very Own Style'
-  #   UI.messagebox('My new style name is: ' + style.name)
-  #
-  # @param name
-  #   - the new name for the style.
   #
-  # @return name - the name that was set.
+  # @param [String] name
   #
   # @version SketchUp 6.0
   def name=(name)

data/SketchUp/Sketchup/Styles.rb

@@ -6,7 +6,7 @@
 #
 # @example
 #   styles = Sketchup.active_model.styles
-#   UI.messagebox "There are " + styles.count.to_s + " styles in your model."
+#   puts "There are #{styles.size} styles in your model."
 #
 # @version SketchUp 6.0
 class Sketchup::Styles < Sketchup::Entity
@@ -17,65 +17,67 @@ class Sketchup::Styles < Sketchup::Entity
 
   # Instance Methods
 
-  # The [] method is used to retrieves a style by either name or index.
+  # The {#[]} method is used to retrieves a style by either name or index.
   #
   # @example
   #   styles = Sketchup.active_model.styles
   #   style1 = styles[0]
-  #   style2 = styles["name"]
+  #   style2 = styles["MyStyle"]
   #
-  # @param name_or_index
-  #   The string name or index for a specific style.
+  # @overload [](name)
   #
-  # @return style - a Style object if successful
+  #   @param [String] name  The name of the style to retrieve.
+  #   @return [Sketchup::Style, nil]
+  #
+  # @overload [](index)
+  #
+  #   @param [Integer] index  The index of the style to retrieve.
+  #   @return [Sketchup::Style, nil]
   #
   # @version SketchUp 6.0
-  def [](name_or_index)
+  def [](arg)
   end
 
-  # The active_style method is used to retrieve the active style.
+  # The #{active_style} method is used to retrieve the active style.
   #
   # @example
   #   styles = Sketchup.active_model.styles
   #   style = styles.active_style
-  #   UI.messagebox('The active style is: ' + active_style.name)
   #
-  # @return style - the active Style object.
+  # @return [Sketchup::Style]
   #
   # @version SketchUp 6.0
   def active_style
   end
 
-  # The active_style_changed method tells you if the active style has been
+  # The {#active_style_changed} method tells you if the active style has been
   # edited by the user since it was last saved.
   #
   # @example
   #   styles = Sketchup.active_model.styles
-  #   user_made_change = styles.active_style_changed
-  #   UI.messagebox ('The active style was edited: ' + user_made_change.to_s)
+  #   style_changed = styles.active_style_changed
   #
-  # @return changed - true if the active style has been changed
-  #   from when it was last saved.
+  # @return [Boolean]
   #
   # @version SketchUp 6.0
   def active_style_changed
   end
 
-  # The add_style method is used to create and load a style from the given file.
+  # The {#add_style} method is used to create and load a style from the given
+  # file.
   #
   # @example
+  #   filename = File.expand_path('./MyStyle.style')
   #   styles = Sketchup.active_model.styles
-  #   status = styles.add_style "c:\\MyStyle.style", true
-  #   UI.messagebox ('A style was added: ' + status.to_s)
+  #   status = styles.add_style(filename, true)
   #
-  # @param filename
-  #   The filename for the style.
+  # @param [String] filename
   #
-  # @param select
-  #   true if you want to set the style to be the active
-  #   style, false if not.
+  # @param [Boolean] select
+  #   +true+ if you want to set the style to be the
+  #   active style.
   #
-  # @return status - true if successful, false if unsuccessful.
+  # @return [Boolean]
   #
   # @version SketchUp 6.0
   def add_style(filename, select)
@@ -90,25 +92,25 @@ class Sketchup::Styles < Sketchup::Entity
   #   +Enumable+ mix-in module. Prior to that the {#count} method is an alias
   #   for {#length}.
   #
-  # @return integer - the number of styles found.
+  # @return [Integer]
   #
   # @version SketchUp 6.0
   def count
   end
 
-  # The each method is used to iterate through styles.
+  # The {#each} method is used to iterate through styles.
   #
   # @example
   #   styles = Sketchup.active_model.styles
-  #   styles.each {| style |
-  #     UI.messagebox('style: ' + style.name)
+  #   styles.each { |style|
+  #     puts style.name
   #   }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   #
-  # @yield [style] Variable that will hold each style as it is found.
+  # @yieldparam [Sketchup::Style] style
   def each
   end
 
@@ -126,46 +128,51 @@ class Sketchup::Styles < Sketchup::Entity
   def length
   end
 
-  # parent pointer, so we can't use the normal "parent" method from Entity
+  # The {#parent} method is used to return the model for the styles.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   model = styles.parent
+  #
+  # @return [Sketchup::Model]
+  #
+  # @version SketchUp 6.0
   def parent
   end
 
-  # The purge_unused method is used to remove unused styles from the model.
+  # The {#purge_unused} method is used to remove unused styles from the model.
   #
   # @example
   #   styles = Sketchup.active_model.styles
-  #   status = styles.purge_unused
-  #   UI.messagebox ('Purging Unused styles status: ' + status.to_s)
+  #   styles.purge_unused
   #
-  # @return status - true if successful, false if unsuccessful.
+  # @return [true]
   #
   # @version SketchUp 6.0
   def purge_unused
   end
 
-  # The selected_style method is used to retrieve the currently selected style.
+  # The {#selected_style} method is used to retrieve the currently selected style.
   #
   # @example
   #   styles = Sketchup.active_model.styles
   #   style = styles.selected_style
-  #   UI.messagebox ('The selected style is: ' + style.name)
   #
-  # @return style - the selected Style object.
+  # @return [Sketchup::Style] style
   #
   # @version SketchUp 6.0
   def selected_style
   end
 
-  # The selected_style= method is used to set the currently selected style.
+  # The {#selected_style=} method is used to set the currently selected style.
   #
   # @example
   #   styles = Sketchup.active_model.styles
-  #   styles.selected_style = styles[styles.count -1]
+  #   styles.selected_style = styles.last
   #
-  # @param style
-  #   The style object to select.
+  # @param [Sketchup::Style] style
   #
-  # @return false
+  # @return [false]
   #
   # @version SketchUp 6.0
   def selected_style=(style)
@@ -186,15 +193,16 @@ class Sketchup::Styles < Sketchup::Entity
   def size
   end
 
-  # The update_selected_style method returns true if the selected style
-  # was changed (e.g. the user selected a different style).
+  # The {#update_selected_style} method commits the current style settings to the
+  # style selected in the Style Browser.
   #
   # @example
   #   styles = Sketchup.active_model.styles
-  #   success = styles.update_selected_style
-  #   UI.messagebox ('The selected style was switched: ' + success.to_s)
+  #   styles.update_selected_style
+  #
+  # @return [true]
   #
-  # @return status - true if the style was switched
+  # @see #selected_style
   #
   # @version SketchUp 6.0
   def update_selected_style

data/SketchUp/Sketchup/Tool.rb

@@ -27,9 +27,9 @@
 #
 # - +CONSTRAIN_MODIFIER_KEY+ = Shift Key
 # - +CONSTRAIN_MODIFIER_MASK+ = Shift Key
-# - +COPY_MODIFIER_KEY+ = Menu on Mac, Ctrl on PC
-# - +COPY_MODIFIER_MASK+ = Alt on Mac, Ctrl on PC
-# - +ALT_MODIFIER_KEY+ = Command on Mac, Menu on PC
+# - +COPY_MODIFIER_KEY+ = Alt/Option on Mac, Ctrl on PC
+# - +COPY_MODIFIER_MASK+ = Alt/Option on Mac, Ctrl on PC
+# - +ALT_MODIFIER_KEY+ = Command on Mac, Alt on PC
 # - +ALT_MODIFIER_MASK+ = Command on Mac, Alt on PC
 #
 # @version SketchUp 6.0

data/SketchUp/sketchup.rb

@@ -48,7 +48,7 @@ module Sketchup
   #     # code acting on the model
   #   end
   #
-  # @return model - active model object if successful, false if
+  # @return [Sketchup::Model] model - active model object if successful, false if
   #   unsuccessful
   #
   # @version SketchUp 6.0
@@ -725,15 +725,15 @@ 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"
+  #   result = Sketchup.read_default "section",
+  #   "variable", "default"
   #
   # @param section
-  #   A section in an .INI or registry.
+  #   A section in an .INI or registry.
   #
   # @param variable
   #   A variable within the section.
@@ -1264,16 +1264,16 @@ module Sketchup
   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).
+  #   A section in a .plist file (Mac) or the registry
+  #   (Windows).
   #
   # @param [String] key
   #   A key within the section.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sketchup-api-stubs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Trimble Inc, SketchUp Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler