sketchup-api-stubs 0.1.2 → 0.2.0

data/SketchUp/UI/Command.rb

@@ -49,11 +49,11 @@ class UI::Command
   #   cmd = UI::Command.new("Tester") { UI.messagebox("Hello World") }
   #   testmenu.add_item cmd
   #
-  # @param menutext
+  # @param [String] menutext
   #   The text that will appear for this command's menu item
   #   if it appears on a menu.
   #
-  # @return command - the new Command object
+  # @return [UI::Command] the new Command object
   #
   # @version SketchUp 6.0
   #
@@ -77,7 +77,7 @@ class UI::Command
   #   toolbar.show
   #   puts cmd.large_icon
   #
-  # @return string - the path to the large icon.
+  # @return [String] the path to the large icon.
   #
   # @version SketchUp 8.0 M1
   def large_icon
@@ -101,10 +101,10 @@ class UI::Command
   #   toolbar = toolbar.add_item cmd
   #   toolbar.show
   #
-  # @param path
+  # @param [String] path
   #   The path to the large icon.
   #
-  # @return command - the Command object
+  # @return [String]
   #
   # @version SketchUp 6.0
   def large_icon=(path)
@@ -121,7 +121,7 @@ class UI::Command
   #   testmenu.add_item cmd
   #   puts cmd.menu_text
   #
-  # @return command - a Command object
+  # @return [String]
   #
   # @version SketchUp 8.0 M1
   def menu_text
@@ -137,10 +137,10 @@ class UI::Command
   #   cmd.menu_text = "New String"
   #   testmenu.add_item cmd
   #
-  # @param menuitem
+  # @param [String] menuitem
   #   A string representing the menu item for the command.
   #
-  # @return command - a Command object
+  # @return [String]
   #
   # @version SketchUp 6.0
   def menu_text=(menuitem)
@@ -189,7 +189,7 @@ class UI::Command
   #   toolbar.show
   #   puts cmd.small_icon
   #
-  # @return string - the path to the small_icon
+  # @return [String] the path to the small_icon
   #
   # @version SketchUp 8.0 M1
   def small_icon
@@ -213,10 +213,10 @@ class UI::Command
   #   toolbar = toolbar.add_item cmd
   #   toolbar.show
   #
-  # @param path
+  # @param [String] path
   #   A path to the small icon.
   #
-  # @return command - the Command object
+  # @return [String]
   #
   # @version SketchUp 6.0
   def small_icon=(path)
@@ -237,7 +237,7 @@ class UI::Command
   #   toolbar.show
   #   puts cmd.status_bar_text
   #
-  # @return string - the status bar text.
+  # @return [String] the status bar text.
   #
   # @version SketchUp 8.0 M1
   def status_bar_text
@@ -256,11 +256,11 @@ class UI::Command
   #   toolbar = toolbar.add_item cmd
   #   toolbar.show
   #
-  # @param text
+  # @param [String] text
   #   The text that will appear on the status bar when the
   #   cursor is over the command's menu item.
   #
-  # @return command - the Command object
+  # @return [String]
   #
   # @version SketchUp 6.0
   def status_bar_text=(text)
@@ -277,7 +277,7 @@ class UI::Command
   #   toolbar.show
   #   puts cmd.tooltip
   #
-  # @return string - the tooltip text
+  # @return [String] the tooltip text
   #
   # @version SketchUp 8.0 M1
   def tooltip
@@ -295,10 +295,10 @@ class UI::Command
   #   toolbar = toolbar.add_item cmd
   #   toolbar.show
   #
-  # @param text
+  # @param [String] text
   #   The text of the tooltip.
   #
-  # @return command - the Command object
+  # @return [String]
   #
   # @version SketchUp 6.0
   def tooltip=(text)

data/SketchUp/UI/HtmlDialog.rb

@@ -33,6 +33,9 @@ class UI::HtmlDialog
   # Basic types such as booleans, numbers, strings, arrays and hashes are
   # automatically converted between Ruby and JavaScript.
   #
+  # @example JavaScript
+  #   sketchup.say('Hello World', 42);
+  #
   # @example JavaScript with callback
   #   sketchup.say('Hello World', 42, {
   #     onCompleted: function() {
@@ -45,8 +48,8 @@ class UI::HtmlDialog
   #     puts "JavaScript said #{param1} and #{param2}"
   #   }
   #
-  # @example JavaScript
-  #   sketchup.say('Hello World', 42);
+  # @note When an HtmlDialog is closed, all callbacks to that instance are
+  #   cleared. Re-attach them if you need to open the dialog again.
   #
   # @param [String] callback_name
   #   The name of the callback method to be
@@ -59,11 +62,11 @@ class UI::HtmlDialog
   #
   # @yield [action_context, ...]
   #
-  # @yieldparam [Object] action_context
-  #   action_context  Currently unused.
-  #
   # @yieldparam [Object] ...
   #   The parameters sent from JavaScript.
+  #
+  # @yieldparam [Object] action_context
+  #   action_context  Currently unused.
   def add_action_callback(callback_name)
   end
 

data/SketchUp/UI/Notification.rb

@@ -104,7 +104,7 @@ class UI::Notification
   #
   # @example
   #   notification = UI::Notification.new(sketchup_extension)
-  #   puts "This is the current message: ${notification.message}"
+  #   puts "This is the current message: #{notification.message}"
   #   notification.show
   #
   # @return [String]

data/SketchUp/UI/Toolbar.rb

@@ -36,10 +36,10 @@ class UI::Toolbar
   # @example
   #   toolbar = UI::Toolbar.new "Test"
   #
-  # @param toolbarname
+  # @param [String] toolbarname
   #   The name for the new toolbar.
   #
-  # @return toolbar - the newly created toolbar object
+  # @return [UI::Toolbar] the newly created toolbar object
   #
   # @version SketchUp 6.0
   def self.new(toolbarname)
@@ -52,11 +52,11 @@ class UI::Toolbar
   # @example
   #   toolbar = toolbar.add_item command
   #
-  # @param command
+  # @param [UI::Command] command
   #   A Command object representing the command to add to the
   #   toolbar.
   #
-  # @return toolbar - the toolbar where the command was just added
+  # @return [UI::Toolbar] the toolbar where the command was just added
   #
   # @version SketchUp 6.0
   def add_item(command)
@@ -67,11 +67,10 @@ class UI::Toolbar
   # @example
   #   toolbar = toolbar.add_separator
   #
-  # @return toolbar - the toolbar where the line separator was just
-  #   added
+  # @return [UI::Toolbar] the toolbar where the line separator was just added
   #
   # @version SketchUp 6.0
-  def add_separator
+  def add_separator(arg)
   end
 
   # The {#count} method is inherited from the +Enumerable+ mix-in module.
@@ -101,7 +100,7 @@ class UI::Toolbar
   #     puts item
   #   }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 8.0 M1
   #
@@ -118,7 +117,7 @@ class UI::Toolbar
   # @example
   #   state = toolbar.get_last_state
   #
-  # @return state - the last state of the toolbar (see comments)
+  # @return [Boolean] the last state of the toolbar (see comments)
   #
   # @version SketchUp 6.0
   def get_last_state
@@ -143,7 +142,7 @@ class UI::Toolbar
   #   toolbar.hide
   #   UI.messagebox "Toolbar Hidden"
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def hide
@@ -174,7 +173,7 @@ class UI::Toolbar
   #   puts toolbar.name
   #   toolbar.show
   #
-  # @return string - the name of the toolbar.
+  # @return [String] the name of the toolbar.
   #
   # @version SketchUp 8.0 M1
   def name
@@ -186,7 +185,7 @@ class UI::Toolbar
   # @example
   #   toolbar.restore
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def restore
@@ -208,7 +207,7 @@ class UI::Toolbar
   #   toolbar = toolbar.add_item cmd
   #   toolbar.show
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def show
@@ -232,7 +231,7 @@ class UI::Toolbar
   # @example
   #   visible = toolbar.visible?
   #
-  # @return true if visible
+  # @return [Boolean]
   #
   # @return [Boolean]
   #

data/SketchUp/UI/WebDialog.rb

@@ -93,11 +93,11 @@ class UI::WebDialog
   # @example
   #   dialog.allow_actions_from_host("sketchup.com")
   #
-  # @param hostname
+  # @param [String] hostname
   #   The name (domain) of the host that your webdialog can
   #   access safely.
   #
-  # @return nil
+  # @return [Boolean]
   #
   # @version SketchUp 6.0
   def allow_actions_from_host(hostname)
@@ -110,7 +110,7 @@ class UI::WebDialog
   # @example
   #   dialog.bring_to_front
   #
-  # @return nil
+  # @return [UI::WebDialog]
   #
   # @version SketchUp 6.0
   def bring_to_front
@@ -121,7 +121,7 @@ class UI::WebDialog
   # @example
   #   dialog.close
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def close
@@ -134,10 +134,10 @@ class UI::WebDialog
   #   js_command = "document.getElementById('id').innerHTML = '<b>Hi!</b>'"
   #   dialog.execute_script(js_command)
   #
-  # @param script
+  # @param [String] script
   #   The JavaScript script to execute on the webdialog.
   #
-  # @return nil
+  # @return [Boolean]
   #
   # @version SketchUp 6.0
   def execute_script(script)
@@ -150,8 +150,7 @@ class UI::WebDialog
   #   dialog.get_default_dialog_color
   #   #ece9d8
   #
-  # @return color - a six digit hexidecimal number representing the
-  #   color
+  # @return [String] a six digit hexidecimal number representing the color
   #
   # @version SketchUp 6.0
   def get_default_dialog_color
@@ -167,10 +166,10 @@ class UI::WebDialog
   #   # In webdialog's HTML:
   #   <input type="text" id="myTextInput" value="hello">
   #
-  # @param element_id
+  # @param [String] element_id
   #   The name of the element in your HTML code.
   #
-  # @return String containing the retrieved value.
+  # @return [String] a string containing the retrieved value.
   #
   # @version SketchUp 6.0
   def get_element_value(element_id)
@@ -240,7 +239,7 @@ class UI::WebDialog
   # @example
   #   max = dialog.max_height
   #
-  # @return height - the maximum height in pixels
+  # @return [Integer] the maximum height in pixels
   #
   # @version SketchUp 7.0
   def max_height
@@ -252,10 +251,10 @@ class UI::WebDialog
   # @example
   #   dialog.max_height = 400
   #
-  # @param height
+  # @param [Integer] height
   #   The maximum height in pixels
   #
-  # @return nil
+  # @return [Integer]
   #
   # @version SketchUp 7.0
   def max_height=(height)
@@ -267,7 +266,7 @@ class UI::WebDialog
   # @example
   #   max = dialog.max_width
   #
-  # @return width - the maximum width in pixels
+  # @return [Integer] the maximum width in pixels
   #
   # @version SketchUp 7.0
   def max_width
@@ -279,10 +278,10 @@ class UI::WebDialog
   # @example
   #   dialog.max_width = 500
   #
-  # @param width
+  # @param [Integer] width
   #   The maximum width in pixels
   #
-  # @return nil
+  # @return [Integer]
   #
   # @version SketchUp 7.0
   def max_width=(width)
@@ -294,7 +293,7 @@ class UI::WebDialog
   # @example
   #   min = dialog.min_height
   #
-  # @return height - the minimum height in pixels
+  # @return [Integer] the minimum height in pixels
   #
   # @version SketchUp 7.0
   def min_height
@@ -306,10 +305,10 @@ class UI::WebDialog
   # @example
   #   dialog.min_height = 100
   #
-  # @param height
+  # @param [Integer] height
   #   The minimum height in pixels
   #
-  # @return nil
+  # @return [Integer]
   #
   # @version SketchUp 7.0
   def min_height=(height)
@@ -321,7 +320,7 @@ class UI::WebDialog
   # @example
   #   min = dialog.min_width
   #
-  # @return width - the minimum width in pixels
+  # @return [Integer] the minimum width in pixels
   #
   # @version SketchUp 7.0
   def min_width
@@ -333,10 +332,10 @@ class UI::WebDialog
   # @example
   #   dialog.min_width = 200
   #
-  # @param width
+  # @param [Integer] width
   #   The minimum width in pixels
   #
-  # @return nil
+  # @return [Integer]
   #
   # @version SketchUp 7.0
   def min_width=(width)
@@ -349,10 +348,7 @@ class UI::WebDialog
   # @example
   #   dialog.navigation_buttons_enabled = false
   #
-  # @param nav_buttons
-  #   true to hide the buttons, false to show them
-  #
-  # @return dialog - the updated WebDialog
+  # @return [Boolean]
   #
   # @version SketchUp 7.0
   def navigation_buttons_enabled=(nav_buttons)
@@ -367,7 +363,7 @@ class UI::WebDialog
   # @example
   #   nav_buttons = dialog.navigation_buttons_enabled?
   #
-  # @return nav_buttons - true if the buttons are visible.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -381,13 +377,13 @@ class UI::WebDialog
   # @example
   #   data = dialog.post_url("http://www.mydomain.com/formchecker.cgi",data)
   #
-  # @param url
+  # @param [String] url
   #   The url to send the data.
   #
-  # @param data
+  # @param [String] data
   #   The data to be sent.
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def post_url(url, data)
@@ -401,7 +397,7 @@ class UI::WebDialog
   # @example
   #   factor = dialog.screen_scale_factor
   #
-  # @return screen scale factor
+  # @return [Float] screen scale factor
   #
   # @version SketchUp 2014
   def screen_scale_factor
@@ -413,10 +409,10 @@ class UI::WebDialog
   # @example
   #   dlg.set_background_color("f3f0f0")
   #
-  # @param color
+  # @param [String] color
   #   A six digit hexidecimal color.
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def set_background_color(color)
@@ -448,7 +444,7 @@ class UI::WebDialog
   # @example
   #   dialog.set_full_security
   #
-  # @return dialog - the updated WebDialog
+  # @return [UI::WebDialog] the updated WebDialog
   #
   # @version SketchUp 7.0
   def set_full_security
@@ -461,10 +457,10 @@ class UI::WebDialog
   #   html= '<b>Hello world!</b>'
   #   dialog.set_html(html)
   #
-  # @param html_string
+  # @param [String] html_string
   #   A string of valid html to display in your webdialog.
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def set_html(html_string)
@@ -476,7 +472,7 @@ class UI::WebDialog
   # @example
   #   dialog.set_on_close{ UI.messagebox("Closing the webDialog") }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   #
@@ -490,13 +486,13 @@ class UI::WebDialog
   # @example
   #   dialog.set_position(100,50)
   #
-  # @param left
+  # @param [Integer] left
   #   The number of pixels from the left.
   #
-  # @param top
+  # @param [Integer] top
   #   The number of pixels from the top of the screen.
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def set_position(left, top)
@@ -507,13 +503,13 @@ class UI::WebDialog
   # @example
   #   dialog.set_size(320,240)
   #
-  # @param w
+  # @param [Integer] w
   #   Width of the webdialog.
   #
-  # @param h
+  # @param [Integer] h
   #   Height of the webdialog.
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def set_size(w, h)
@@ -525,10 +521,10 @@ class UI::WebDialog
   # @example
   #   dialog.set_url "http://www.sketchup.com"
   #
-  # @param url
+  # @param [String] url
   #   The URL for a specific web site.
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def set_url(url)
@@ -541,7 +537,7 @@ class UI::WebDialog
   #     dialog.execute_script("alert(10)");
   #   }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   #
@@ -561,7 +557,7 @@ class UI::WebDialog
   #     dialog.execute_script("alert(10)");
   #   }
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 6.0
   #
@@ -575,7 +571,7 @@ class UI::WebDialog
   # @example
   #   vis = dialog.visible?
   #
-  # @return visibility - true if visible.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -590,29 +586,29 @@ class UI::WebDialog
   #   dialog.write_image('c:/grab.jpg', 70, 0, 0, 100, 100)
   #   dialog.write_image('c:/grab.png', 4, 0, 0, 100, 100)
   #
-  # @param option
+  # @param [Integer] top_left_x
+  #   The x coordinate of the upper left corner of the
+  #   region to grab.
+  #
+  # @param [String] image_path
+  #   The destination path of the saved image.
+  #
+  # @param [Integer] option
   #   Specifies what method to use when saving the image. For
   #   JPG/JPEG images, this specifies the image quality and
   #   can range from 1 to 100. For PNG images this specifies
   #   the compression algorithm: <4 (best speed), 4-8
   #   (default), or >=9 (best compression).
   #
-  # @param image_path
-  #   The destination path of the saved image.
-  #
-  # @param bottom_right_y
+  # @param [Integer] bottom_right_y
   #   The x coordinate of the lower right corner of the
   #   region to grab.
   #
-  # @param bottom_right_x
+  # @param [Integer] bottom_right_x
   #   The x coordinate of the lower right corner of the
   #   region to grab.
   #
-  # @param top_left_y
-  #   The x coordinate of the upper left corner of the
-  #   region to grab.
-  #
-  # @param top_left_x
+  # @param [Integer] top_left_y
   #   The x coordinate of the upper left corner of the
   #   region to grab.
   #