Skip to content

Commit 2e4286f

Browse files
committed
Adds documentation to the two new pin variants.
1 parent 802235c commit 2e4286f

2 files changed

Lines changed: 18 additions & 2 deletions

File tree

OpenIPSL/Interfaces/PwPin_n.mo

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,14 @@ connector PwPin_n
1313
extent={{-100,100},{100,-100}},
1414
lineColor={0,0,255},
1515
fillColor={255,255,255},
16-
fillPattern=FillPattern.Solid)}));
16+
fillPattern=FillPattern.Solid)}),
17+
Documentation(info="<html>
18+
<p>
19+
This connector <code>PwPin_n</code> is nearly identical to
20+
<a href=\"modelica://OpenIPSL.Interfaces.PwPin_p\">PwPin_p</a>
21+
(and <a href=\"modelica://OpenIPSL.Interfaces.PwPin\">PwPin</a>).
22+
The only difference is that the default component name is set to \"n\"
23+
and that the icons are different in order to identify more easily the pins of a component.
24+
</p>
25+
</html>"));
1726
end PwPin_n;

OpenIPSL/Interfaces/PwPin_p.mo

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,12 @@ within OpenIPSL.Interfaces;
22
connector PwPin_p
33
"Positive connector for electrical blocks treating voltage and current as complex variables"
44
extends PwPin;
5-
annotation (defaultComponentName="p");
5+
annotation (defaultComponentName="p", Documentation(info="<html>
6+
<p>
7+
This connector <code>PwPin_p</code> is nearly identical to
8+
<a href=\"modelica://OpenIPSL.Interfaces.PwPin\">PwPin</a>.
9+
The only difference is that the default component name is set to \"p\"
10+
in order to identify more easily the pins of a component.
11+
</p>
12+
</html>"));
613
end PwPin_p;

0 commit comments

Comments
 (0)