sketchup-api-stubs 0.1.2 → 0.2.0

data/SketchUp/Sketchup/ComponentDefinition.rb

@@ -1,16 +1,23 @@
 # Copyright:: Copyright 2017 Trimble Inc.
 # License:: The MIT License (MIT)
 
-# The ComponentDefinition class is used to define the contents for a SketchUp
-# component. Components are a collection of entities that can be instanced
-# and reused multiple times throughout a model. For example, you could
-# draw a chair once, turn it into a component, and then use 6 instances of
-# it to surround a table. Edits to the original "definition" will then
+# The {Sketchup::ComponentDefinition} class is used to define the contents for
+# a SketchUp component. Components are a collection of entities that can be
+# instanced and reused multiple times throughout a model. For example, you
+# could draw a chair once, turn it into a component, and then use 6 instances
+# of it to surround a table. Edits to the original "definition" will then
 # propagate across all of its instances.
 #
-# The ComponentDefinition class contains the global entities and settings
-# for each definition. See the ComponentInstance class for how each copy
-# is defined.
+# The ComponentDefinition class contains the global entities and settings for
+# each definition. See the {Sketchup::ComponentInstance} class for how each
+# copy is defined.
+#
+# Starting from SketchUp 2018+, the {Sketchup::ComponentDefinition} class
+# contains a new default attribute dictionary named "SU_DefinitionSet" with
+# default keys named named "Price", "Size", "Url". See the
+# {https://help.sketchup.com/en/article/3000124 Help article} for more
+# information. The dictionary cannot be deleted via ruby and an ArgumentError
+# will be raised. The key/value pairs in the dictionary can be deleted safely.
 #
 # @version SketchUp 6.0
 class Sketchup::ComponentDefinition < Sketchup::Drawingelement
@@ -33,10 +40,10 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #     UI.messagebox("c1 sorts before c2")
   #   end
   #
-  # @param compdef2
+  # @param [Sketchup::ComponentDefinition] compdef2
   #   The second component definition in the comparison.
   #
-  # @return status - a -1 if component1 is less then component2. A 1
+  # @return [Integer] a -1 if component1 is less then component2. A 1
   #   if component1 greater than component2
   #
   # @version SketchUp 6.0
@@ -55,10 +62,10 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #     UI.messagebox("These definitions are the same.")
   #   end
   #
-  # @param compdef2
+  # @param [Sketchup::ComponentDefinition] compdef2
   #   The second component definition in the comparison.
   #
-  # @return status - true if the ComponentDefinition objects are
+  # @return [Boolean] true if the ComponentDefinition objects are
   #   the same object. False if the objects are not the same.
   #
   # @version SketchUp 6.0
@@ -74,13 +81,13 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   definition = Sketchup.active_model.definitions.first
   #   success = definition.add_classification("IFC 2x3", "IfcDoor")
   #
-  # @param schema_name
+  # @param [String] schema_name
   #   a String - Schema name to add
   #
-  # @param schema_type
+  # @param [String] schema_type
   #   a String - Schema type to add
   #
-  # @return true if the classification succeeds. Otherwise false.
+  # @return [Boolean] true if the classification succeeds. Otherwise false.
   #
   # @version SketchUp 2015
   def add_classification(schema_name, schema_type)
@@ -92,10 +99,10 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = Sketchup.active_model.definitions[0]
   #   status = componentdefinition.add_observer observer
   #
-  # @param observer
+  # @param [Object] observer
   #   An observer.
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def add_observer(observer)
@@ -112,7 +119,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = definitions.load path
   #   behavior = componentdefinition.behavior
   #
-  # @return behavior - a Behavior object if successful
+  # @return [Sketchup::Behavior] a Behavior object if successful
   #
   # @version SketchUp 6.0
   def behavior
@@ -130,7 +137,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   definition = definitions.load(path)
   #   number = definition.count_instances
   #
-  # @return count - the number of component instances of this
+  # @return [Integer] the number of component instances of this
   #   component definition (if successful)
   #
   # @version SketchUp 6.0
@@ -148,7 +155,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   definition = definitions.load(path)
   #   number = definition.count_used_instances
   #
-  # @return count - the number of component instances of this
+  # @return [Integer] the number of component instances of this
   #   component definition (if successful)
   #
   # @version SketchUp 2016
@@ -165,8 +172,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = Sketchup.active_model.definitions[0]
   #   description = componentdefinition.description
   #
-  # @return description - the description of the component
-  #   definition if successful
+  # @return [String] the description of the component definition if successful
   #
   # @version SketchUp 6.0
   def description
@@ -182,7 +188,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #
   # @param [String] description
   #
-  # @return status - the description if successful, false if
+  # @return [String] the description if successful, false if
   #   unsuccessful
   #
   # @version SketchUp 6.0
@@ -196,7 +202,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = Sketchup.active_model.definitions[0]
   #   entities = componentdefinition.entities
   #
-  # @return entities - an Entities object if successful
+  # @return [Sketchup::Entities] an Entities object if successful
   #
   # @version SketchUp 6.0
   def entities
@@ -212,10 +218,10 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   path = ["IFC 2x3", "IfcDoor", "ObjectType", "IfcLabel"]
   #   value = definition.get_classification_value(path)
   #
-  # @param path
+  # @param [Array<String>] path
   #   An array composed of the key path to the value.
   #
-  # @return mixed - a Ruby object if successful, nil otherwise.
+  # @return [Object, nil] a Ruby object if successful, nil otherwise.
   #
   # @version SketchUp 2015
   def get_classification_value(path)
@@ -232,8 +238,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = definitions.load path
   #   status = componentdefinition.group?
   #
-  # @return status - true if the definition is used to hold a
-  #   group, false if the definition does not hold a group.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -249,7 +254,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = Sketchup.active_model.definitions[0]
   #   guid = componentdefinition.guid
   #
-  # @return guid - a string guid if successful
+  # @return [String] a string guid if successful
   #
   # @version SketchUp 6.0
   def guid
@@ -262,8 +267,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = Sketchup.active_model.definitions[0]
   #   status = componentdefinition.hidden?
   #
-  # @return status - true if the definition should be hidden, false
-  #   if the definition should not be hidden
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -284,9 +288,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #     UI.messagebox "Component definition does not define an image"
   #   end
   #
-  # @return status - true if the component definition defines an
-  #   image, false if the component definition does not
-  #   define an image.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -309,7 +311,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   instance = entities.add_instance componentdefinition, transform
   #   point = componentdefinition.insertion_point
   #
-  # @return point - the Point3d where the component was inserted if
+  # @return [Geom::Point3d] the Point3d where the component was inserted if
   #   successful. False if unsuccessful.
   #
   # @version SketchUp 6.0
@@ -340,8 +342,8 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = Sketchup.active_model.definitions[0]
   #   instances = componentdefinition.instances
   #
-  # @return instances - an array of ComponentInstances (if
-  #   successful)
+  # @return [Array<Sketchup::ComponentInstance>] an array of ComponentInstances
+  #   (if successful)
   #
   # @version SketchUp 6.0
   def instances
@@ -361,9 +363,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = definitions.load path
   #   status = componentdefinition.internal?
   #
-  # @return status - true if the component definition is internal
-  #   to SketchUp's Component Browser.  False if the
-  #   component definition is not internal to SketchUp.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -383,7 +383,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = Sketchup.active_model.definitions[0]
   #   componentdefinition.invalidate_bounds
   #
-  # @return true if successful
+  # @return [Boolean] true if successful
   #
   # @version SketchUp 6.0
   def invalidate_bounds
@@ -399,7 +399,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = definitions.load path
   #   name = componentdefinition.name
   #
-  # @return name - the component definition's name if successful
+  # @return [String] the component definition's name if successful
   #
   # @version SketchUp 6.0
   def name
@@ -417,7 +417,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #
   # @param [String] name
   #
-  # @return name - the name assigned to the component definition if
+  # @return [String] the name assigned to the component definition if
   #   successful
   #
   # @version SketchUp 6.0
@@ -436,7 +436,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = definitions.load path
   #   path = componentdefinition.path
   #
-  # @return path - a valid path if successful, false if
+  # @return [String, false] a valid path if successful, false if
   #   unsuccessful
   #
   # @version SketchUp 6.0
@@ -452,7 +452,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = Sketchup.active_model.definitions[0]
   #   componentdefinition.refresh_thumbnail
   #
-  # @return nil
+  # @return [nil]
   #
   # @version SketchUp 7.0
   def refresh_thumbnail
@@ -467,15 +467,15 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   definition = Sketchup.active_model.definitions.first
   #   success = definition.remove_classification("IFC 2x3", "IfcDoor")
   #
-  # @param schema_name
-  #   a String - Schema name to remove
+  # @param [String] schema_name
+  #   Schema name to remove
   #
-  # @param schema_type
-  #   a String - Schema type to remove. If not provided or an
+  # @param [String] schema_type
+  #   Schema type to remove. If not provided or an
   #   empty string, the currently applied schema type for the
   #   given schema name will be removed.
   #
-  # @return true if the removal succeeds. Otherwise false.
+  # @return [Boolean] true if the removal succeeds. Otherwise false.
   #
   # @version SketchUp 2015
   def remove_classification(schema_name, schema_type)
@@ -488,10 +488,10 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   componentdefinition = Sketchup.active_model.definitions[0]
   #   status = componentdefinition.remove_observer observer
   #
-  # @param observer
+  # @param [Object] observer
   #   An observer.
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def remove_observer(observer)
@@ -504,10 +504,10 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   my_definition = Sketchup.active_model.definitions[0]
   #   success = my_definition.save_as "c:\\myComponent.skp"
   #
-  # @param file_path
+  # @param [String] file_path
   #   Local file path to save the .skp file to.
   #
-  # @return true if successful
+  # @return [Boolean] true if successful
   #
   # @version SketchUp 7.0
   def save_as(file_path)
@@ -523,7 +523,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #
   # @param [String] filename
   #
-  # @return true if successful, false otherwise.
+  # @return [Boolean] true if successful, false otherwise.
   #
   # @version SketchUp 7.0
   def save_thumbnail(filename)
@@ -539,12 +539,12 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #   path = ["IFC 2x3", "IfcDoor", "ObjectType", "IfcLabel"]
   #   success = definition.set_classification_value(path, "Room 101")
   #
-  # @param value
-  #   A value valid for that specific attribute.
-  #
-  # @param path
+  # @param [Array<String>] path
   #   An array composed of the key path to the value.
   #
+  # @param [Object] value
+  #   A value valid for that specific attribute.
+  #
   # @raise [NotImplementedError] when trying to set the value of "choice"
   #   attributes.
   #
@@ -553,7 +553,7 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #
   # @raise [RuntimeError] if the attributes being set are corrupt.
   #
-  # @return boolean - true if the path was valid, false otherwise.
+  # @return [Boolean] true if the path was valid, false otherwise.
   #
   # @version SketchUp 2015
   def set_classification_value(path, value)

data/SketchUp/Sketchup/ComponentInstance.rb

@@ -1,12 +1,19 @@
 # Copyright:: Copyright 2017 Trimble Inc.
 # License:: The MIT License (MIT)
 
-# The ComponentInstance class is used to represent component instances of a
-# component definition or components that have been dragged from the Component
-# Browser and placed (thus, instanced) within the Model. Therefore, the
-# ComponentInstance class contains a reference to a corresponding
-# ComponentDefinition object and a Transformation object (which contains the
-# location of the component in the Drawing Window).
+# The {Sketchup::ComponentInstance} class is used to represent component
+# instances of a component definition or components that have been dragged from
+# the Component Browser and placed (thus, instanced) within the Model.
+# Therefore, the ComponentInstance class contains a reference to a
+# corresponding ComponentDefinition object and a Transformation object (which
+# contains the location of the component in the Drawing Window).
+#
+# Starting from SketchUp 2018+, the {Sketchup::ComponentInstance} class
+# contains default attributes when created or imported. The attributes
+# are: "Owner", "Status". See the
+# {https://help.sketchup.com/en/article/3000124 Help article} for more
+# information. The dictionary cannot be deleted via ruby and an @raise ArgumentError
+# will be raised. The key/value pairs in the dictionary can be deleted safely.
 #
 # @version SketchUp 6.0
 class Sketchup::ComponentInstance < Sketchup::Drawingelement
@@ -22,10 +29,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   componentinstance = entities.add_instance(definition, transformation)
   #   status = componentinstance.add_observer observer
   #
-  # @param observer
+  # @param [Object] observer
   #   An observer.
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def add_observer(observer)
@@ -44,7 +51,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   # You can get an instance's definition with this method.
   #   definition = componentinstance.definition
   #
-  # @return componentdefinition - a ComponentDefinition object if
+  # @return [Sketchup::ComponentDefinition] a ComponentDefinition object if
   #   successful
   #
   # @version SketchUp 6.0
@@ -69,10 +76,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   # Replace 2nd instance with the 1st definition.
   #   instance2.definition = definition1
   #
-  # @param definition
+  # @param [Sketchup::ComponentDefinition] definition
   #   A ComponentDefinition object to set.
   #
-  # @return componentdefinition - the ComponentDefinition object
+  # @return [Sketchup::ComponentDefinition] the ComponentDefinition object
   #   that was set if successful, false if unsuccessful
   #
   # @version SketchUp 6.0
@@ -88,12 +95,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   status = instance1.equals?(instance2)
   #
-  # @param instance
+  # @param [Sketchup::ComponentInstance] instance
   #   The instance to compare this instance with.
   #
-  # @return status - true if the instances are geometrically
-  #   equivalent.
-  #   Otherwise false.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -113,7 +118,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #     UI.messagebox "Failure"
   #   end
   #
-  # @return An array of entity objects if successful, false if
+  # @return [Array<Sketchup:Entity>] An array of entity objects if successful, false if
   #   unsuccessful
   #
   # @version SketchUp 6.0
@@ -137,7 +142,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance = entities.add_instance componentdefinition, transform
   #   status = instance.glued_to
   #
-  # @return entity - the Entity object that the instance is glued
+  # @return [Sketchup::Face, nil] the Entity object that the instance is glued
   #   to (if successful)
   #
   # @version SketchUp 6.0
@@ -180,9 +185,9 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #     UI.messagebox "Failure"
   #   end
   #
-  # @param [Sketchup::Face] face
+  # @param [Sketchup::Face, nil] face
   #
-  # @return face - the Face object where the component is glued if
+  # @return [Sketchup::Face, nil] - the Face object where the component is glued if
   #   successful
   #
   # @version SketchUp 6.0
@@ -199,7 +204,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   componentinstance = entities.add_instance(definition, transformation)
   #   guid = componentinstance.guid
   #
-  # @return guid - a unique 22 character string
+  # @return [String] a unique 22 character string
   #
   # @version SketchUp 2014
   def guid
@@ -215,10 +220,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   result = instance1.intersect(instance2)
   #
-  # @param instance
+  # @param [Sketchup::ComponentInstance] instance
   #   The instance to intersect this instance with.
   #
-  # @return result - The resultant group if the two objects
+  # @return [Sketchup::Group, nil] The resultant group if the two objects
   #   (this and arg) represent manifold solids and the
   #   operation succeeds otherwise nil is returned.
   #
@@ -237,7 +242,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #
   # @param [Boolean] lock
   #
-  # @return status - true if the component instance is locked.
+  # @return [Boolean] true if the component instance is locked.
   #   False if the instance is not locked.
   #
   # @version SketchUp 6.0
@@ -253,8 +258,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   componentinstance = entities.add_instance(definition, transformation)
   #   status = componentinstance.locked?
   #
-  # @return status - true if the component instance is locked.
-  #   False if the instance is not locked.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -279,7 +283,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   # Returns unique component instance
   #   status = instance.make_unique
   #
-  # @return status - true if successful, false if unsuccessful
+  # @return [Boolean] true if successful, false if unsuccessful
   #
   # @version SketchUp 6.0
   def make_unique
@@ -294,8 +298,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   componentinstance = entities.add_instance(definition, transformation)
   #   status = componentinstance.manifold?
   #
-  # @return status - true if the instance is manifold.
-  #   false if the instance is not manifold.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -317,10 +320,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   new_transformation = Geom::Transformation.new([100,0,0])
   #   componentinstance.move! new_transformation
   #
-  # @param transform
+  # @param [Geom::Transformation] transform
   #   The transform object to apply to the component instance.
   #
-  # @return status - true if successful, false if unsuccessful
+  # @return [Boolean] true if successful, false if unsuccessful
   #
   # @version SketchUp 6.0
   def move!(transform)
@@ -335,7 +338,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   componentinstance = entities.add_instance(definition, transformation)
   #   name = componentinstance.name
   #
-  # @return name - the string name of the ComponentInstance
+  # @return [String] the string name of the ComponentInstance
   #
   # @version SketchUp 6.0
   def name
@@ -350,10 +353,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   componentinstance = entities.add_instance(definition, transformation)
   #   componentinstance.name = "Sang"
   #
-  # @param name
-  #   name - the string name to set
+  # @param [String] name
+  #   the string name to set
   #
-  # @return instance - the newly named ComponentInstance
+  # @return [Sketchup::ComponentInstance] the newly named ComponentInstance
   #
   # @version SketchUp 6.0
   def name=(name)
@@ -369,10 +372,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   result = instance1.outer_shell(instance2)
   #
-  # @param instance
+  # @param [Sketchup::ComponentInstance] instance
   #   The instance to outer shell this instance with.
   #
-  # @return result - The resultant group if the two objects
+  # @return [Sketchup::Group, nil] The resultant group if the two objects
   #   (this and arg) represent manifold solids and the
   #   operation succeeds otherwise nil is returned.
   #
@@ -390,10 +393,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   componentinstance = entities.add_instance(definition, transformation)
   #   status = componentinstance.remove_observer observer
   #
-  # @param observer
+  # @param [Object] observer
   #   An observer.
   #
-  # @return true if successful, false if unsuccessful.
+  # @return [Boolean] true if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0
   def remove_observer(observer)
@@ -417,14 +420,14 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   status = instance1.show_differences(instance2, true)
   #
-  # @param instance
+  # @param [Sketchup::ComponentInstance] instance
   #   The instance to be compared with.
   #
-  # @param verbose
+  # @param [Boolean] verbose
   #   A boolean flag indicating whether to display a textural
   #   report of the found differences to the Ruby console.
   #
-  # @return status - true if the instances are geometrically
+  # @return [Boolean] true if the instances are geometrically
   #   equivalent, otherwise false.
   #
   # @version SketchUp 8.0
@@ -441,12 +444,12 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   result = instance1.split(instance2)
   #
-  # @param instance
+  # @param [Sketchup::ComponentInstance, nil] instance
   #   The instance to split this instance with.
   #
-  # @return result - A vector (array) of the three resultant groups
+  # @return [Array(Sketchup::Group, Sketchup::Group, Sketchup::Group)] A vector (array) of the three resultant groups
   #   if the two objects (this and arg) represent manifold
-  #   solids and the operation succeeds otherwise Qnil is
+  #   solids and the operation succeeds otherwise nil is
   #   returned. The 3 groups are as follows: The intersection
   #   of volume 1 & volume 2, the difference of
   #   volume 1 minus volume 2, and the reverse difference of
@@ -466,10 +469,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   result = instance1.subtract(instance2)
   #
-  # @param instance
+  # @param [Sketchup::ComponentInstance] instance
   #   The instance to subtract this instance from.
   #
-  # @return result - The resultant group if the two objects
+  # @return [Sketchup::Group, nil] The resultant group if the two objects
   #   (this and arg) represent manifold solids and the
   #   operation succeeds otherwise nil is returned.
   #
@@ -506,8 +509,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   componentinstance = entities.add_instance(definition, transformation)
   #   t = componentinstance.transformation
   #
-  # @return transformation - the Transformation object if
-  #   successful
+  # @return [Geom::Transformation] the Transformation object if successful
   #
   # @version SketchUp 6.0
   def transformation
@@ -524,10 +526,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   new_transformation = Geom::Transformation.new([100,0,0])
   #   componentinstance.transformation = new_transformation
   #
-  # @param transformation
+  # @param [Geom::Transformation] transformation
   #   A Transformation object to apply.
   #
-  # @return instance - the transformed ComponentInstance
+  # @return [Sketchup::ComponentInstance] the transformed ComponentInstance
   #
   # @version SketchUp 6.0
   def transformation=(transformation)
@@ -544,10 +546,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   result = instance1.trim(instance2)
   #
-  # @param instance
+  # @param [Sketchup::ComponentInstance] instance
   #   The instance to trim this instance against.
   #
-  # @return result - The resultant group if the two objects
+  # @return [Sketchup::Group, nil] The resultant group if the two objects
   #   (this and arg) represent manifold solids and the
   #   operation succeeds otherwise nil is returned.
   #
@@ -565,10 +567,10 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   result = instance1.union(instance2)
   #
-  # @param instance
+  # @param [Sketchup::ComponentInstance] instance
   #   The instance to union this instance with.
   #
-  # @return result - The resultant group if the two objects
+  # @return [Sketchup::Group, nil] The resultant group if the two objects
   #   (this and arg) represent manifold solids and the
   #   operation succeeds otherwise nil is returned.
   #
@@ -586,7 +588,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   componentinstance = entities.add_instance(definition, transformation)
   #   volume = componentinstance.volume
   #
-  # @return volume - If the instance represents a manifold volume,
+  # @return [Float] If the instance represents a manifold volume,
   #   volume will be a positive value.  If volume is negative,
   #   the instance is not manifold.
   #