Added documentation for packages

ibpsa · May 16, 2024 · 7b83317 · 7b83317
1 parent 064efbe
commit 7b83317
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 3 deletions.
diff --git a/IBPSA/ThermalZones/ISO13790/Validation/BESTEST/Cases6xx/Case680.mo b/IBPSA/ThermalZones/ISO13790/Validation/BESTEST/Cases6xx/Case680.mo
@@ -1,7 +1,7 @@
 within IBPSA.ThermalZones.ISO13790.Validation.BESTEST.Cases6xx;
 model Case680 "Case 600, but with increased exterior wall and roof insulation"
-  extends IBPSA.ThermalZones.ISO13790.Validation.BESTEST.Cases6xx.Case600(zonHVAC(UWal
-        =0.15, URoo=0.1));
+  extends IBPSA.ThermalZones.ISO13790.Validation.BESTEST.Cases6xx.Case600(zonHVAC(UWal=
+         0.15, URoo=0.1));
  annotation (
   __Dymola_Commands(file="modelica://IBPSA/Resources/Scripts/Dymola/ThermalZones/ISO13790/Validation/BESTEST/Cases6xx/Case680.mos"
         "Simulate and plot"),

diff --git a/IBPSA/ThermalZones/ISO13790/Validation/BESTEST/Cases6xx/package.mo b/IBPSA/ThermalZones/ISO13790/Validation/BESTEST/Cases6xx/package.mo
@@ -1,4 +1,15 @@
 within IBPSA.ThermalZones.ISO13790.Validation.BESTEST;
 package Cases6xx
   extends Modelica.Icons.ExamplesPackage;
+
+annotation (preferredView="info", Documentation(info="<html>
+<p>
+This package contains the validation cases of the 600 series
+of the BESTEST validation (ANSI/ASHRAE 2007).
+</p>
+<h4>References</h4>
+<p>
+ANSI/ASHRAE. 2007. ANSI/ASHRAE Standard 140-2007, Standard Method of Test for the Evaluation of Building Energy Analysis Computer Programs.
+</p>
+</html>"));
 end Cases6xx;
diff --git a/IBPSA/ThermalZones/ISO13790/Validation/BESTEST/Cases9xx/package.mo b/IBPSA/ThermalZones/ISO13790/Validation/BESTEST/Cases9xx/package.mo
@@ -2,4 +2,14 @@ within IBPSA.ThermalZones.ISO13790.Validation.BESTEST;
 package Cases9xx
   extends Modelica.Icons.ExamplesPackage;
 
+annotation (preferredView="info", Documentation(info="<html>
+<p>
+This package contains the validation cases of the 900 series
+of the BESTEST validation (ANSI/ASHRAE 2007).
+</p>
+<h4>References</h4>
+<p>
+ANSI/ASHRAE. 2007. ANSI/ASHRAE Standard 140-2007, Standard Method of Test for the Evaluation of Building Energy Analysis Computer Programs.
+</p>
+</html>"));
 end Cases9xx;
diff --git a/IBPSA/ThermalZones/ISO13790/Zone5R1C/Zone.mo b/IBPSA/ThermalZones/ISO13790/Zone5R1C/Zone.mo
@@ -389,7 +389,7 @@ If a wall contains only opaque parts, the corresponding window area must be set
 <li>
 The parameter <code>coeFac</code> is used to vary the g-factor as a function of the incident angle 
 of the surface. Often, the curve can be approximated by a cubic polynomial, as shown in 
-<a href=\"IBPSA.ThermalZones.ISO13790.Validation.BESTEST.Case600\">
+<a href=\"modelica://IBPSA.ThermalZones.ISO13790.Validation.BESTEST.Cases6xx.Case600\">
 IBPSA.ThermalZones.ISO13790.Validation.BESTEST.Case600</a>. When this information is not available,
 the parameter <code>coeFac</code> must be set to <i>1</i>. 
 </li>