Improve documentation of both rotational and translational sensors (m…

…odelica#3862) * Unify documentation of both translational and rotational sensors
AHaumer · Feb 1, 2022 · 23a70a7 · 23a70a7
1 parent b7e8b8e
commit 23a70a7
Show file tree

Hide file tree

Showing 20 changed files with 106 additions and 79 deletions.
diff --git a/Modelica/Mechanics/Rotational/Sensors/AccSensor.mo b/Modelica/Mechanics/Rotational/Sensors/AccSensor.mo
@@ -1,6 +1,6 @@
 within Modelica.Mechanics.Rotational.Sensors;
 model AccSensor
-  "Ideal sensor to measure the absolute flange angular acceleration"
+  "Ideal sensor to measure the absolute angular acceleration of flange"
 
   extends Rotational.Interfaces.PartialAbsoluteSensor;
   SI.AngularVelocity w "Absolute angular velocity of flange";
@@ -14,9 +14,11 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <strong>absolute angular acceleration a</strong> of a flange in an ideal
-way and provides the result as output signal <strong>a</strong> (to be further processed with
-blocks of the Modelica.Blocks library).
+Measures the <em>absolute angular acceleration</em>
+of a&nbsp;flange in an ideal way and provides the result as
+output signal&nbsp;<code>a</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
 </html>"),
        Icon(coordinateSystem(

diff --git a/Modelica/Mechanics/Rotational/Sensors/AngleSensor.mo b/Modelica/Mechanics/Rotational/Sensors/AngleSensor.mo
@@ -1,5 +1,5 @@
 within Modelica.Mechanics.Rotational.Sensors;
-model AngleSensor "Ideal sensor to measure the absolute flange angle"
+model AngleSensor "Ideal sensor to measure the absolute angle of flange"
 
   extends Rotational.Interfaces.PartialAbsoluteSensor;
   Modelica.Blocks.Interfaces.RealOutput phi(unit="rad", displayUnit="deg")
@@ -10,9 +10,11 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <strong>absolute angle phi</strong> of a flange in an ideal
-way and provides the result as output signal <strong>phi</strong>
-(to be further processed with blocks of the Modelica.Blocks library).
+Measures the <em>absolute angle</em>
+of a&nbsp;flange in an ideal way and provides the result as
+output signal&nbsp;<code>phi</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
 </html>"),
        Icon(coordinateSystem(

diff --git a/Modelica/Mechanics/Rotational/Sensors/MultiSensor.mo b/Modelica/Mechanics/Rotational/Sensors/MultiSensor.mo
@@ -1,6 +1,6 @@
 within Modelica.Mechanics.Rotational.Sensors;
 model MultiSensor
-  "Ideal sensor to measure the torque and power between two flanges (= flange_a.tau*der(flange_a.phi)) and the absolute angular velocity"
+  "Ideal sensor to measure the absolute angular velocity, torque and power between two flanges"
   extends .Modelica.Mechanics.Rotational.Interfaces.PartialRelativeSensor;
   Modelica.Blocks.Interfaces.RealOutput power(unit="W")
     "Power in flange flange_a as output signal"
@@ -27,7 +27,11 @@ equation
   power = tau*w;
   annotation (
     Documentation(info="<html>
-<p>Measures the <strong>absolute angular velocity</strong> of a flange_a, the <strong>cut-torque</strong> and <strong>power</strong> between two flanges in an ideal way and provides the results as output signals <strong>w</strong>, <strong>tau</strong> and <strong>power</strong>, respectively.
+<p>
+Measures the <em>absolute angular velocity</em> of the <code>flange_a</code> and
+the <em>cut-torque</em> and <em>power</em> between two flanges
+in an ideal way and provides the results as output signals&nbsp;<code>w</code>,
+<code>tau</code> and <code>power</code>, respectively.
 </p>
 </html>"),
        Icon(coordinateSystem(

diff --git a/Modelica/Mechanics/Rotational/Sensors/PowerSensor.mo b/Modelica/Mechanics/Rotational/Sensors/PowerSensor.mo
@@ -1,6 +1,6 @@
 within Modelica.Mechanics.Rotational.Sensors;
 model PowerSensor
-  "Ideal sensor to measure the power between two flanges (= flange_a.tau*der(flange_a.phi))"
+  "Ideal sensor to measure the power between two flanges"
 
   extends Rotational.Interfaces.PartialRelativeSensor;
   Modelica.Blocks.Interfaces.RealOutput power(unit="W")
@@ -16,10 +16,14 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <strong>power between two flanges</strong> in an ideal way
-and provides the result as output signal <strong>power</strong>
-(to be further processed with blocks of the Modelica.Blocks library).
+Measures the <em>power</em> between two flanges
+in an ideal way and provides the result as output signal <code>power</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library), i.e.
 </p>
+<blockquote><pre>
+power = flange_a.tau * der(flange_a.phi)
+</pre></blockquote>
 </html>"),
        Icon(
     coordinateSystem(preserveAspectRatio=true,

diff --git a/Modelica/Mechanics/Rotational/Sensors/RelAccSensor.mo b/Modelica/Mechanics/Rotational/Sensors/RelAccSensor.mo
@@ -22,9 +22,10 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <strong>relative angular acceleration a_rel</strong> between two flanges
-in an ideal way and provides the result as output signal <strong>a_rel</strong>
-(to be further processed with blocks of the Modelica.Blocks library).
+Measures the <em>relative angular acceleration</em> between two flanges
+in an ideal way and provides the result as output signal <code>a_rel</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
 </html>"),
        Icon(

diff --git a/Modelica/Mechanics/Rotational/Sensors/RelAngleSensor.mo b/Modelica/Mechanics/Rotational/Sensors/RelAngleSensor.mo
@@ -16,9 +16,10 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <strong>relative angle phi_rel</strong> between two flanges
-in an ideal way and provides the result as output signal <strong>phi_rel</strong>
-(to be further processed with blocks of the Modelica.Blocks library).
+Measures the <em>relative angle</em> between two flanges
+in an ideal way and provides the result as output signal <code>phi_rel</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
 </html>"),
        Icon(

diff --git a/Modelica/Mechanics/Rotational/Sensors/RelSpeedSensor.mo b/Modelica/Mechanics/Rotational/Sensors/RelSpeedSensor.mo
@@ -20,9 +20,10 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <strong>relative angular velocity w_rel</strong> between two flanges
-in an ideal way and provides the result as output signal <strong>w_rel</strong>
-(to be further processed with blocks of the Modelica.Blocks library).
+Measures the <em>relative angular velocity</em> between two flanges
+in an ideal way and provides the result as output signal <code>w_rel</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
 </html>"),
        Icon(

diff --git a/Modelica/Mechanics/Rotational/Sensors/SpeedSensor.mo b/Modelica/Mechanics/Rotational/Sensors/SpeedSensor.mo
@@ -1,6 +1,6 @@
 within Modelica.Mechanics.Rotational.Sensors;
 model SpeedSensor
-  "Ideal sensor to measure the absolute flange angular velocity"
+  "Ideal sensor to measure the absolute angular velocity of flange"
 
   extends Rotational.Interfaces.PartialAbsoluteSensor;
   Modelica.Blocks.Interfaces.RealOutput w(unit="rad/s")
@@ -12,9 +12,11 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <strong>absolute angular velocity w</strong> of a flange in an ideal
-way and provides the result as output signal <strong>w</strong>
-(to be further processed with blocks of the Modelica.Blocks library).
+Measures the <em>absolute angular velocity</em>
+of a&nbsp;flange in an ideal way and provides the result as
+output signal&nbsp;<code>w</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
 </html>"),
        Icon(coordinateSystem(

diff --git a/Modelica/Mechanics/Rotational/Sensors/TorqueSensor.mo b/Modelica/Mechanics/Rotational/Sensors/TorqueSensor.mo
@@ -1,6 +1,6 @@
 within Modelica.Mechanics.Rotational.Sensors;
 model TorqueSensor
-  "Ideal sensor to measure the torque between two flanges (= flange_a.tau)"
+  "Ideal sensor to measure the torque between two flanges"
 
   extends Rotational.Interfaces.PartialRelativeSensor;
   Modelica.Blocks.Interfaces.RealOutput tau(unit="N.m")
@@ -16,9 +16,10 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <strong>cut-torque between two flanges</strong> in an ideal way
-and provides the result as output signal <strong>tau</strong>
-(to be further processed with blocks of the Modelica.Blocks library).
+Measures the <em>cut-torque</em> between two flanges
+in an ideal way and provides the result as output signal <code>tau</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
 </html>"),
        Icon(

diff --git a/Modelica/Mechanics/Rotational/Sensors/package.mo b/Modelica/Mechanics/Rotational/Sensors/package.mo
@@ -6,7 +6,7 @@ package Sensors "Sensors to measure variables in 1D rotational mechanical compon
 <p>
 This package contains ideal sensor components that provide
 the connector variables as signals for further processing with the
-Modelica.Blocks library.
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library.
 </p>
 </html>"));
 end Sensors;
diff --git a/Modelica/Mechanics/Translational/Sensors/AccSensor.mo b/Modelica/Mechanics/Translational/Sensors/AccSensor.mo
@@ -1,5 +1,5 @@
 within Modelica.Mechanics.Translational.Sensors;
-model AccSensor "Ideal sensor to measure the absolute acceleration"
+model AccSensor "Ideal sensor to measure the absolute acceleration of flange"
   extends Translational.Interfaces.PartialAbsoluteSensor;
   SI.Velocity v "Absolute velocity of flange";
   Modelica.Blocks.Interfaces.RealOutput a(unit="m/s2")
@@ -12,12 +12,12 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <em>absolute acceleration a</em>
-of a flange in an ideal way and provides the result as
-output signals (to be further processed with blocks of the
-Modelica.Blocks library).
+Measures the <em>absolute acceleration</em>
+of a&nbsp;flange in an ideal way and provides the result as
+output signal&nbsp;<code>a</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
-
 </html>"),
        Icon(coordinateSystem(preserveAspectRatio=true, extent={{-100,-100},
             {100,100}}), graphics={

diff --git a/Modelica/Mechanics/Translational/Sensors/ForceSensor.mo b/Modelica/Mechanics/Translational/Sensors/ForceSensor.mo
@@ -13,11 +13,11 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <em>cut-force between two flanges</em> in an ideal way
-and provides the result as output signal (to be further processed
-with blocks of the Modelica.Blocks library).
+Measures the <em>cut-force</em> between two flanges
+in an ideal way and provides the result as output signal&nbsp;<code>f</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
-
 </html>"),
        Icon(coordinateSystem(preserveAspectRatio=true, extent={{-100,-100},
             {100,100}}), graphics={    Line(points={{-80,-100},

diff --git a/Modelica/Mechanics/Translational/Sensors/MultiSensor.mo b/Modelica/Mechanics/Translational/Sensors/MultiSensor.mo
@@ -15,7 +15,7 @@ model MultiSensor
         rotation=90,
         origin={0,-110})));
   Modelica.Blocks.Interfaces.RealOutput v(unit="m/s")
-    "Absolute velocity of flange as output signal as output signal"
+    "Absolute velocity of flange as output signal"
     annotation (Placement(transformation(
         extent={{-10,-10},{10,10}},
         rotation=-90,
@@ -29,8 +29,11 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <strong>absolute velocity</strong> of a flange_a, the <strong>cut-force</strong> and <strong>power</strong> between two flanges in an
-ideal way and provides the results as output signals <strong>v</strong>, <strong>f</strong> and <strong>power</strong>, respectively.</p>
+Measures the <em>absolute velocity</em> of the <code>flange_a</code> and
+the <em>cut-force</em> and <em>power</em> between two flanges
+in an ideal way and provides the results as output signals&nbsp;<code>v</code>,
+<code>f</code> and <code>power</code>, respectively.
+</p>
 </html>"),
        Icon(coordinateSystem(preserveAspectRatio=true, extent={{-100,-100},
             {100,100}}), graphics={    Line(points={{-60,

diff --git a/Modelica/Mechanics/Translational/Sensors/PositionSensor.mo b/Modelica/Mechanics/Translational/Sensors/PositionSensor.mo
@@ -1,5 +1,5 @@
 within Modelica.Mechanics.Translational.Sensors;
-model PositionSensor "Ideal sensor to measure the absolute position"
+model PositionSensor "Ideal sensor to measure the absolute position of flange"
   extends Translational.Interfaces.PartialAbsoluteSensor;
   Modelica.Blocks.Interfaces.RealOutput s(unit="m")
     "Absolute position of flange as output signal" annotation (Placement(
@@ -11,11 +11,12 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <em>absolute position s</em> of a flange in an ideal way and provides the result as
-output signals (to be further processed with blocks of the
-Modelica.Blocks library).
+Measures the <em>absolute position</em>
+of a&nbsp;flange in an ideal way and provides the result as
+output signal&nbsp;<code>s</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
-
 </html>"),
        Icon(coordinateSystem(preserveAspectRatio=true, extent={{-100,-100},
             {100,100}}), graphics={

diff --git a/Modelica/Mechanics/Translational/Sensors/PowerSensor.mo b/Modelica/Mechanics/Translational/Sensors/PowerSensor.mo
@@ -1,6 +1,6 @@
 within Modelica.Mechanics.Translational.Sensors;
 model PowerSensor
-  "Ideal sensor to measure the power between two flanges (= flange_a.f*der(flange_a.s))"
+  "Ideal sensor to measure the power between two flanges"
   extends Translational.Interfaces.PartialRelativeSensor;
   Modelica.Blocks.Interfaces.RealOutput power(unit="W")
     "Power in flange flange_a as output signal" annotation (Placement(
@@ -14,10 +14,14 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <strong>power between two flanges</strong> in an ideal way
-and provides the result as output signal <strong>power</strong>
-(to be further processed with blocks of the Modelica.Blocks library).
+Measures the <em>power</em> between two flanges
+in an ideal way and provides the result as output signal <code>power</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library), i.e.
 </p>
+<blockquote><pre>
+power = flange_a.f * der(flange_a.s)
+</pre></blockquote>
 </html>"),
        Icon(coordinateSystem(preserveAspectRatio=true, extent={{-100,-100},
             {100,100}}), graphics={    Line(points={{-80,

diff --git a/Modelica/Mechanics/Translational/Sensors/RelAccSensor.mo b/Modelica/Mechanics/Translational/Sensors/RelAccSensor.mo
@@ -1,8 +1,8 @@
 within Modelica.Mechanics.Translational.Sensors;
-model RelAccSensor "Ideal sensor to measure the relative acceleration"
+model RelAccSensor "Ideal sensor to measure the relative acceleration between two flanges"
   extends Translational.Interfaces.PartialRelativeSensor;
-  SI.Position s_rel "Distance between the two flanges (flange_b.s - flange_a.s)";
-  SI.Velocity v_rel "Relative velocity between the two flanges (der(flange_b.s) - der(flange_a.s))";
+  SI.Position s_rel "Relative distance between two flanges (flange_b.s - flange_a.s)";
+  SI.Velocity v_rel "Relative velocity between two flanges (der(flange_b.s) - der(flange_a.s))";
   Modelica.Blocks.Interfaces.RealOutput a_rel(unit="m/s2")
     "Relative acceleration between two flanges (= der(v_rel)) as output signal"
     annotation (Placement(transformation(
@@ -18,11 +18,11 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <em>relative acceleration a</em> of a flange in an ideal way and provides the result as
-output signals (to be further processed with blocks of the
-Modelica.Blocks library).
+Measures the <em>relative acceleration</em> between two flanges
+in an ideal way and provides the result as output signal <code>a_rel</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
-
 </html>"),
        Icon(coordinateSystem(preserveAspectRatio=true, extent={{-100,-100},
             {100,100}}), graphics={

diff --git a/Modelica/Mechanics/Translational/Sensors/RelPositionSensor.mo b/Modelica/Mechanics/Translational/Sensors/RelPositionSensor.mo
@@ -1,8 +1,8 @@
 within Modelica.Mechanics.Translational.Sensors;
-model RelPositionSensor "Ideal sensor to measure the relative position"
+model RelPositionSensor "Ideal sensor to measure the relative position between two flanges"
   extends Translational.Interfaces.PartialRelativeSensor;
   Modelica.Blocks.Interfaces.RealOutput s_rel(unit="m")
-    "Distance between two flanges (= flange_b.s - flange_a.s) as output signal"
+    "Relative distance between two flanges (= flange_b.s - flange_a.s) as output signal"
     annotation (Placement(transformation(
         extent={{-10,-10},{10,10}},
         rotation=270,
@@ -14,11 +14,11 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <em>relative position s</em> of a flange in an ideal way and provides the result as
-output signals (to be further processed with blocks of the
-Modelica.Blocks library).
+Measures the <em>relative position</em> between two flanges
+in an ideal way and provides the result as output signal <code>s_rel</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
-
 </html>"),
        Icon(coordinateSystem(preserveAspectRatio=true, extent={{-100,-100},
             {100,100}}), graphics={

diff --git a/Modelica/Mechanics/Translational/Sensors/RelSpeedSensor.mo b/Modelica/Mechanics/Translational/Sensors/RelSpeedSensor.mo
@@ -1,7 +1,7 @@
 within Modelica.Mechanics.Translational.Sensors;
-model RelSpeedSensor "Ideal sensor to measure the relative speed"
+model RelSpeedSensor "Ideal sensor to measure the relative velocity between two flanges"
   extends Translational.Interfaces.PartialRelativeSensor;
-  SI.Position s_rel "Distance between the two flanges (flange_b.s - flange_a.s)";
+  SI.Position s_rel "Relative distance between two flanges (flange_b.s - flange_a.s)";
   Modelica.Blocks.Interfaces.RealOutput v_rel(unit="m/s")
     "Relative velocity between two flanges (= der(flange_b.s) - der(flange_a.s)) as output signal"
     annotation (Placement(transformation(
@@ -16,11 +16,11 @@ equation
   annotation (
     Documentation(info="<html>
 <p>
-Measures the <em>relative speed v</em> of a flange in an ideal way and provides the result as
-output signals (to be further processed with blocks of the
-Modelica.Blocks library).
+Measures the <em>relative velocity</em> between two flanges
+in an ideal way and provides the result as output signal <code>v_rel</code>
+(to be further processed with blocks of the
+<a href=\"modelica://Modelica.Blocks\">Modelica.Blocks</a> library).
 </p>
-
 </html>",
       revisions="<html>
 <p><strong>Release Notes:</strong></p>