lib/openstudio-standards/standards/Standards.BoilerHotWater.rb in openstudio-standards-0.2.14 vs lib/openstudio-standards/standards/Standards.BoilerHotWater.rb in openstudio-standards-0.2.15.pre.rc1

@@ -1,10 +1,11 @@
 class Standard
   # @!group BoilerHotWater
 
   # find search criteria
   #
+  # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
   # @return [Hash] used for standards_lookup_table(model)
   def boiler_hot_water_find_search_criteria(boiler_hot_water)
     # Define the criteria to find the boiler properties
     # in the hvac standards data set.
     search_criteria = {}
@@ -33,10 +34,11 @@
     return search_criteria
   end
 
   # Find capacity in W
   #
+  # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
   # @return [Double] capacity in W
   def boiler_hot_water_find_capacity(boiler_hot_water)
     capacity_w = nil
     if boiler_hot_water.nominalCapacity.is_initialized
       capacity_w = boiler_hot_water.nominalCapacity.get
@@ -51,10 +53,11 @@
     return capacity_w
   end
 
   # Finds lookup object in standards and return minimum thermal efficiency
   #
+  # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
   # @return [Double] minimum thermal efficiency
   def boiler_hot_water_standard_minimum_thermal_efficiency(boiler_hot_water, rename = false)
     # Get the boiler properties
     search_criteria = boiler_hot_water_find_search_criteria(boiler_hot_water)
     capacity_w = boiler_hot_water_find_capacity(boiler_hot_water)
@@ -106,11 +109,11 @@
     return thermal_eff
   end
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] the object to modify
-  # @return [Bool] true if successful, false if not
+  # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] hot water boiler object
+  # @return [Bool] returns true if successful, false if not
   def boiler_hot_water_apply_efficiency_and_curves(boiler_hot_water)
     successfully_set_all_properties = false
 
     # Define the criteria to find the boiler properties
     # in the hvac standards data set.