lib/openstudio-standards/standards/Standards.ZoneHVACComponent.rb in openstudio-standards-0.4.0 vs lib/openstudio-standards/standards/Standards.ZoneHVACComponent.rb in openstudio-standards-0.5.0.rc1

@@ -12,11 +12,11 @@
   # Sets the fan power of zone level HVAC equipment
   # (Fan coils, Unit Heaters, PTACs, PTHPs, VRF Terminals, WSHPs, ERVs)
   # based on the W/cfm specified in the standard.
   #
   # @param zone_hvac_component [OpenStudio::Model::ZoneHVACComponent] zone hvac component
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def zone_hvac_component_apply_prm_baseline_fan_power(zone_hvac_component)
     OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.ZoneHVACComponent', "Setting fan power for #{zone_hvac_component.name}.")
 
     # Convert this to the actual class type
     zone_hvac = if zone_hvac_component.to_ZoneHVACFourPipeFanCoil.is_initialized
@@ -136,11 +136,11 @@
 
   # If the supply air fan operating mode schedule is always off (to follow load),
   # and the zone requires ventilation, override it to follow the zone occupancy schedule
   #
   # @param zone_hvac_component [OpenStudio::Model::ZoneHVACComponent] zone hvac component
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def zone_hvac_component_occupancy_ventilation_control(zone_hvac_component)
     ventilation = false
     # Zone HVAC operating schedule if providing ventilation
     # Zone HVAC components return an OptionalSchedule object for supplyAirFanOperatingModeSchedule
     # except for ZoneHVACTerminalUnitVariableRefrigerantFlow which returns a Schedule
@@ -214,11 +214,11 @@
   end
 
   # Apply all standard required controls to the zone equipment
   #
   # @param zone_hvac_component [OpenStudio::Model::ZoneHVACComponent] zone hvac component
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def zone_hvac_component_apply_standard_controls(zone_hvac_component)
     # Vestibule heating control
     if zone_hvac_component_vestibule_heating_control_required?(zone_hvac_component)
       zone_hvac_component_apply_vestibule_heating_control(zone_hvac_component)
     end
@@ -260,29 +260,29 @@
 
   # Determine if vestibule heating control is required.
   # Defaults to 90.1-2004 through 2010, not required.
   #
   # @param zone_hvac_component [OpenStudio::Model::ZoneHVACComponent] zone hvac component
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def zone_hvac_component_vestibule_heating_control_required?(zone_hvac_component)
     vest_htg_control_required = false
     return vest_htg_control_required
   end
 
   # Add occupant standby controls to zone equipment
   # Currently, the controls consists of cycling the
   # fan during the occupant standby mode hours
   #
   # @param zone_hvac_component OpenStudio zonal equipment object
-  # @retrun [Boolean] true if sucessful, false otherwise
+  # @return [Boolean] true if sucessful, false otherwise
   def zone_hvac_model_standby_mode_occupancy_control(zone_hvac_component)
     return true
   end
 
   # Turns off vestibule heating below 45F
   #
   # @param zone_hvac_component [OpenStudio::Model::ZoneHVACComponent] zone hvac component
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def zone_hvac_component_apply_vestibule_heating_control(zone_hvac_component)
     # Ensure that the equipment is assigned to a thermal zone
     if zone_hvac_component.thermalZone.empty?
       OpenStudio.logFree(OpenStudio::Warn, 'openstudio.model.ZoneHVACComponent', "For #{zone_hvac_component.name}: equipment is not assigned to a thermal zone, cannot apply vestibule heating control.")
       return true