yard documentation fixes

.yardopts

@@ -22,6 +22,7 @@ lib/openstudio-standards/schedules/**/*.rb
 lib/openstudio-standards/space/**/*.rb
 lib/openstudio-standards/sql_file/**/*.rb
 lib/openstudio-standards/standards/**/*.rb
+lib/openstudio-standards/thermal_zone/**/*.rb
 lib/openstudio-standards/utilities/**/*.rb
 lib/openstudio-standards/weather/**/*.rb
 -

lib/openstudio-standards/schedules/parametric.rb

@@ -387,14 +387,26 @@ def self.model_apply_parametric_schedules(model,
 
     # @!group Parametric:Spaces
 
-    # Gathers parametric inputs for all loads objects associated with spaces/space types in provided array
+    # Gathers parametric inputs for all loads objects associated with spaces/space types in provided array.
+    # Parametric formulas are encoded in AdditionalProperties objects attached to the ScheduleRuleset.
     #
     # @author David Goldwasser
     # @param spaces_space_types [Array] array of OpenStudio::Model::Space or OpenStudio::Model::SpaceType objects
-    # @param parametric_inputs [Hash] parametric inputs hash of ScheduleRuleset => {floor: schedule floor, ceiling: schedule ceiling, target: load instance, hoo_inputs: hours_of_operation hash}
+    # @param parametric_inputs [Hash] parametric inputs hash of ScheduleRuleset, example:
+    #   {
+    #     floor: schedule floor,
+    #     ceiling: schedule ceiling,
+    #     target: load instance,
+    #     hoo_inputs: hours_of_operation hash
+    #   }
     # @param gather_data_only [Boolean] if true, no changes will be made to schedules
-    # @return [Hash] parametric inputs hash of ScheduleRuleset => {floor: schedule floor, ceiling: schedule ceiling, target: load instance, hoo_inputs: hours_of_operation hash}.
-    #   parametric formulas are encoded in AdditionalProperties objects attached to the ScheduleRuleset
+    # @return [Hash] parametric inputs hash of ScheduleRuleset, example:
+    #   {
+    #     floor: schedule floor,
+    #     ceiling: schedule ceiling,
+    #     target: load instance,
+    #     hoo_inputs: hours_of_operation hash
+    #   }
     def self.spaces_space_types_get_parametric_schedule_inputs(spaces_space_types, parametric_inputs, gather_data_only)
       spaces_space_types.each do |space_type|
         # get hours of operation for space type once
@@ -457,18 +469,25 @@ def self.spaces_space_types_get_parametric_schedule_inputs(spaces_space_types, p
     # @param space_load_instance [OpenStudio::Model::SpaceLoadInstance] OpenStudio SpaceLoadInstance object
     # @param parametric_inputs [Hash]
     # @param hours_of_operation [Hash] hash, example:
-    #   { profile_index: {
-    #     hoo_start: [float] rule operation start hour,
-    #     hoo_end: [float] rule operation end hour,
-    #     hoo_hours: [float] rule operation duration hours,
-    #     days_used: [Array] annual day indices
+    #   {
+    #     profile_index: {
+    #       hoo_start: [float] rule operation start hour,
+    #       hoo_end: [float] rule operation end hour,
+    #       hoo_hours: [float] rule operation duration hours,
+    #       days_used: [Array] annual day indices
     #     }
     #   }
     # @param ramp [Boolean] flag to add intermediate values ramp between input schedule values
     # @param min_ramp_dur_hr [Double] minimum time difference to ramp between
     # @param gather_data_only [Boolean] if true, no changes are made to schedules
     # @param hoo_var_method [String] accepts hours and fractional. Any other value value will result in hoo variables not being applied
-    # @return [Hash] parametric inputs hash of ScheduleRuleset => {floor: schedule floor, ceiling: schedule ceiling, target: load instance, hoo_inputs: hours_of_operation hash}
+    # @return [Hash] parametric inputs hash of ScheduleRuleset, example:
+    #   {
+    #     floor: schedule floor,
+    #     ceiling: schedule ceiling,
+    #     target: load instance,
+    #     hoo_inputs: hours_of_operation hash
+    #   }
     def self.schedule_ruleset_get_parametric_inputs(schedule_ruleset, space_load_instance, parametric_inputs, hours_of_operation,
                                                     ramp: true,
                                                     min_ramp_dur_hr: 2.0,

lib/openstudio-standards/standards/Standards.Model.rb

@@ -2356,7 +2356,7 @@ def model_apply_infiltration_standard(model)
   #   the objects will only be returned if the specified area is between the minimum_area and maximum_area values.
   # @param num_floors [Double] capacity of the object in question.  If num_floors is supplied,
   #   the objects will only be returned if the specified num_floors is between the minimum_floors and maximum_floors values.
-  # @param fan_motor_hp [Double] fan motor brake horsepower.
+  # @param fan_motor_bhp [Double] fan motor brake horsepower.
   # @param volume [Double] Equipment storage capacity in gallons.
   # @param capacity_per_volume [Double] Equipment capacity per storage capacity in Btu/h/gal.
   # @return [Array] returns an array of hashes, one hash per object.  Array is empty if no results.