Updated documentation sections for all models

lbl-srg · Feb 20, 2024 · 0229f85 · 0229f85
1 parent ff028c7
commit 0229f85
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 11 deletions.
diff --git a/Buildings/Fluid/Humidifiers/EvaporativeCoolers/Validation/IndirectDry.mo b/Buildings/Fluid/Humidifiers/EvaporativeCoolers/Validation/IndirectDry.mo
@@ -222,10 +222,12 @@ equation
     temperatures in Modelica are in Kelvin whereas they are in Celsius in EnergyPlus. 
     Hence, the EnergyPlus values are corrected by using the appropriate conversion 
     blocks.</p>
-<p>The validation generates three subplots. </p>
-<p>Subplot 1 shows the inlet air mass flowrate from the EnergyPlus model varying with the cooling load. </p>
-<p>Subplot 2 compares the outlet air dry bulb temperature generated by Modelica and EnergyPlus model. </p>
-<p>Subplot 3 compares the outlet air humidity ratio generated by Modelica and EnergyPlus model. </p>
+    <p>The validation generates three subplots. </p>
+    <ul>
+<li>Subplot 1 shows the inlet air mass flowrate from the EnergyPlus model varying with the cooling load. </li>
+<li>Subplot 2 compares the outlet air dry bulb temperature generated by Modelica and EnergyPlus model. </li>
+<li>Subplot 3 compares the outlet air humidity ratio generated by Modelica and EnergyPlus model. </li>
+</ul>
 <p>The validation results demostrate that, with time-varying air flow rate, the 
 Modelica model can effectively capture the dynamics of outlet air humidity ratio 
 and dry bulb temperature, which match the data generated by Energyplus. </p>

diff --git a/Buildings/Fluid/Humidifiers/EvaporativeCoolers/Validation/IndirectWet.mo b/Buildings/Fluid/Humidifiers/EvaporativeCoolers/Validation/IndirectWet.mo
@@ -211,12 +211,14 @@ equation
     temperatures in Modelica are in Kelvin whereas they are in Celsius in EnergyPlus. 
     Hence, the EnergyPlus values are corrected by using the appropriate conversion blocks.</p>
     <p>The validation generates three subplots. </p>
-    <p>Subplot 1 shows the inlet air mass flowrate from the EnergyPlus model varying 
-    with the cooling load. </p>
-    <p>Subplot 2 compares the outlet air dry bulb temperature generated by Modelica 
-    and EnergyPlus model. </p>
-    <p>Subplot 3 compares the outlet air humidity ratio generated by Modelica and 
-    EnergyPlus model. </p>
+    <ul>
+    <li>Subplot 1 shows the inlet air mass flowrate from the EnergyPlus model varying 
+    with the cooling load. </li>
+    <li>Subplot 2 compares the outlet air dry bulb temperature generated by Modelica 
+    and EnergyPlus model. </li>
+    <li>Subplot 3 compares the outlet air humidity ratio generated by Modelica and 
+    EnergyPlus model. </li>
+    </ul>
     <p>The validation results demostrate that, with time-varying air flow rate, 
     the Modelica model can effectively capture the dynamics of outlet air humidity 
     ratio and dry bulb temperature, which match the data generated by Energyplus. </p>

diff --git a/Buildings/Fluid/Humidifiers/EvaporativeCoolers/Validation/package.mo b/Buildings/Fluid/Humidifiers/EvaporativeCoolers/Validation/package.mo
@@ -4,6 +4,11 @@ package Validation "Collection of models that validate the evaporative cooler mo
   extends Modelica.Icons.ExamplesPackage;
 
   annotation (Documentation(info="<html>
-<p>This package contains models that validate the models in <a href=\"modelica://Buildings.Fluid.Humidifiers.EvaporativeCoolers\">Buildings.Fluid.Humidifiers.EvaporativeCoolers</a>. The examples plot various outputs, which have been verified against analytical solutions. These model outputs are stored as reference data to allow continuous validation whenever models in the library change. </p>
+  <p>This package contains models that validate the models in 
+  <a href=\"modelica://Buildings.Fluid.Humidifiers.EvaporativeCoolers\">
+  Buildings.Fluid.Humidifiers.EvaporativeCoolers</a>. The examples plot various 
+  outputs, which have been verified against analytical solutions from EnergyPlus. 
+  These model outputs are stored as reference data to allow continuous validation 
+  whenever models in the library change. </p>
 </html>"));
 end Validation;