ref #4921 - Document in RefrigerationAirChiller why ZoneHVACRefrigrer…

…ationAirChillerSet isn't needed
NREL · Jul 5, 2023 · 2af6123 · 2af6123
1 parent 79e9fe3
commit 2af6123
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/model/RefrigerationAirChiller.hpp b/src/model/RefrigerationAirChiller.hpp
@@ -25,7 +25,10 @@ namespace model {
 
   }  // namespace detail
 
-  /** RefrigerationAirChiller is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:Refrigeration:AirChiller'. */
+  /** RefrigerationAirChiller is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:Refrigeration:AirChiller'.
+    *
+    * This component is a ZoneHVACComponent, and you can call RefrigerationAirChiller::addToThermalZone(ThermalZone&) and the ForwardTranslator will
+    * produce a ZoneHVAC:RefrigerationAirChillerSet for you: a ZoneHVACRefrigrerationAirChillerSet class is not needed in the model SDK. */
   class MODEL_API RefrigerationAirChiller : public ZoneHVACComponent
   {
    public: