Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation of Examples package #1808

Merged
merged 1 commit into from
Oct 25, 2023
Merged

Updated documentation of Examples package #1808

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions IBPSA/Examples/package.mo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,20 @@ package Examples "Collection of models that illustrate model use and test models
extends Modelica.Icons.ExamplesPackage;
annotation (preferredView="info", Documentation(info="<html>
<p>
This package contains examples for the use of models that can be found in
<a href=\"modelica://IBPSA\">
IBPSA</a>.
This package contains examples and tutorials with step-by-step instructions
for how to build system models.
</p>
<p>
The examples illustrate
the scope of the library. Smaller examples that typically only
use models from a few packages can be found in the individual packages.
For example, see
<a href=\"modelica://Buildings.Airflow.Multizone.Examples\">
Buildings.Airflow.Multizone.Examples</a> for examples of
multizone airflow and contaminant transport models, or
<a href=\"modelica://IBPSA.Fluid.HeatExchangers.Examples\">
IBPSA.Fluid.HeatExchangers.Examples</a> for
examples of heat exchanger models.
</p>
</html>"));
end Examples;