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

@@ -1,13 +1,13 @@
 class Standard
   # @!group CoilHeatingDXSingleSpeed
 
   include CoilDX
 
-  # Finds capacity in W.  This is the cooling capacity of the
-  # paired DX cooling coil.
+  # Finds capacity in W.  This is the cooling capacity of the paired DX cooling coil.
   #
+  # @param coil_heating_dx_single_speed [OpenStudio::Model::CoilHeatingDXSingleSpeed] coil heating dx single speed object
   # @return [Double] capacity in W to be used for find object
   def coil_heating_dx_single_speed_find_capacity(coil_heating_dx_single_speed)
     capacity_w = nil
 
     # Get the paired cooling coil
@@ -23,11 +23,11 @@
           unitary = containing_comp.to_AirLoopHVACUnitarySystem.get
           if unitary.coolingCoil.is_initialized
             clg_coil = unitary.coolingCoil.get
           end
         end
-        # TODO: Add other unitary systems
+        # @todo Add other unitary systems
       elsif coil_heating_dx_single_speed.containingZoneHVACComponent.is_initialized
         containing_comp = coil_heating_dx_single_speed.containingZoneHVACComponent.get
         # PTHP
         if containing_comp.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
           pthp = containing_comp.to_ZoneHVACPackagedTerminalHeatPump.get
@@ -100,10 +100,12 @@
     return capacity_w
   end
 
   # Finds lookup object in standards and return efficiency
   #
+  # @param coil_heating_dx_single_speed [OpenStudio::Model::CoilHeatingDXSingleSpeed] coil heating dx single speed object
+  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
   # @return [Double] full load efficiency (COP)
   def coil_heating_dx_single_speed_standard_minimum_cop(coil_heating_dx_single_speed, rename = false)
     # find ac properties
     search_criteria = coil_dx_find_search_criteria(coil_heating_dx_single_speed)
     sub_category = search_criteria['subcategory']
@@ -173,10 +175,12 @@
     return cop
   end
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param coil_heating_dx_single_speed [OpenStudio::Model::CoilHeatingDXSingleSpeed] coil heating dx single speed object
+  # @param sql_db_vars_map [Hash] hash map
+  # @return [Hash] hash of coil objects
   def coil_heating_dx_single_speed_apply_efficiency_and_curves(coil_heating_dx_single_speed, sql_db_vars_map)
     successfully_set_all_properties = true
 
     # Get the search criteria
     search_criteria = coil_dx_find_search_criteria(coil_heating_dx_single_speed)