Skip to content

Commit

Permalink
Deploying to gh-pages from @ d139a41 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
noam987 committed May 7, 2024
1 parent a07bb16 commit 2eaabb4
Show file tree
Hide file tree
Showing 9 changed files with 54 additions and 31 deletions.
2 changes: 1 addition & 1 deletion classpros_1_1v5_1_1MotorGroup.html
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ <h2><a href="#motor-configuration-functions">Motor configuration functions</a></
<dt>
<span class="m-doc-wrap-bumper">std::int8_t </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ga58fa63da3d1dcbc00dd616bbff0ac16e" class="m-doc-self">get_port</a>(</span><span class="m-doc-wrap">const std::uint8_t index = 0) const <span class="m-label m-warning">virtual</span></span></span>
</dt>
<dd>Gets the port of a motor in the motor group.</dd>
<dd>Gets the port of a motor in the motor group via index.</dd>
<dt>
<span class="m-doc-wrap-bumper">void </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#gab244261fee2f43ccf660e81159478e5d" class="m-doc-self">operator+=</a>(</span><span class="m-doc-wrap"><a href="classpros_1_1v5_1_1MotorGroup.html" class="m-doc">MotorGroup</a>&amp;)</span></span>
</dt>
Expand Down
18 changes: 12 additions & 6 deletions group__cpp-motor-group.html
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ <h2><a href="#motor-configuration-functions">Motor configuration functions</a></
<dt>
<span class="m-doc-wrap-bumper">std::int8_t </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ga58fa63da3d1dcbc00dd616bbff0ac16e" class="m-doc-self">get_port</a>(</span><span class="m-doc-wrap">const std::uint8_t index = 0) const <span class="m-label m-warning">virtual</span></span></span>
</dt>
<dd>Gets the port of a motor in the motor group.</dd>
<dd>Gets the port of a motor in the motor group via index.</dd>
<dt>
<span class="m-doc-wrap-bumper">void </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#gab244261fee2f43ccf660e81159478e5d" class="m-doc-self">operator+=</a>(</span><span class="m-doc-wrap">MotorGroup&amp;)</span></span>
</dt>
Expand Down Expand Up @@ -2805,18 +2805,24 @@ <h3>
<span class="m-doc-wrap-bumper">std::int8_t </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ga58fa63da3d1dcbc00dd616bbff0ac16e" class="m-doc-self">get_port</a>(</span><span class="m-doc-wrap">const std::uint8_t index = 0) const <span class="m-label m-warning">virtual</span></span></span>
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="motor__group_8hpp.html">&lt;pros/motor_group.hpp&gt;</a></div>
</h3>
<p>Gets the port of a motor in the motor group.</p>
<p>Gets the port of a motor in the motor group via index.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">index</td>
<td>Optional parameter, 0 by default. The zero indexed index of the motor in the motor group</td>
</tr>
</tbody>
<tfoot>
<tr>
<th style="width: 1%">Returns</th>
<th>Returns</th>
<td>The port of the motor at the specified index. The return value is negative if the corresponding motor is reversed</td>
</tr>
</tfoot>
</table>
<pre> * \param index Optional parameter, 0 by default.
The zero indexed index of the motor in the motor group
</pre>
</div></section>
<section class="m-doc-details" id="gab244261fee2f43ccf660e81159478e5d"><div>
<h3>
Expand Down
7 changes: 4 additions & 3 deletions group__cpp-motors.html
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ <h2><a href="#var-members">Variables</a></h2>
<dt>
std::int8_t <a href="#ga715fb6eb00c706e6cc966bfb82570c9e" class="m-doc">_port</a>
</dt>
<dd><span></span></dd>
<dd>The port of the motor.</dd>
</dl>
</section>
<section>
Expand Down Expand Up @@ -500,7 +500,7 @@ <h3>
<span class="w"> </span><span class="n">Motor</span><span class="w"> </span><span class="n">first_motor</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span><span class="w"> </span><span class="c1">//Creates a motor on port 1 without altering gearset or encoder units</span>
<span class="w"> </span><span class="n">Motor</span><span class="w"> </span><span class="n">reversed_motor</span><span class="p">(</span><span class="mi">-2</span><span class="p">);</span><span class="w"> </span><span class="c1">//Creates a reversed motor on port 1 port 1 without altering gearset or encoder units</span>
<span class="w"> </span><span class="n">Motor</span><span class="w"> </span><span class="n">blue_motor</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="n">pros</span><span class="o">::</span><span class="n">v5</span><span class="o">::</span><span class="n">MotorGears</span><span class="o">::</span><span class="n">blue</span><span class="p">);</span><span class="w"> </span><span class="c1">//Creates a motor on port 3 with blue gear set</span>
<span class="w"> </span><span class="n">Motor</span><span class="w"> </span><span class="n">rotations_motor</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="n">pros</span><span class="o">::</span><span class="n">v5</span><span class="o">::</span><span class="n">MotorGears</span><span class="o">::</span><span class="n">green</span><span class="p">,</span><span class="w"> </span><span class="n">pros</span><span class="o">::</span><span class="n">v5</span><span class="o">::</span><span class="n">MotorUnits</span><span class="o">::</span><span class="n">rotations</span><span class="p">);</span><span class="w"> </span><span class="n">port</span><span class="w"> </span><span class="mi">4</span><span class="w"> </span><span class="n">w</span><span class="o">/</span><span class="w"> </span><span class="n">rotations</span>
<span class="w"> </span><span class="n">Motor</span><span class="w"> </span><span class="n">rotations_motor</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="n">pros</span><span class="o">::</span><span class="n">v5</span><span class="o">::</span><span class="n">MotorGears</span><span class="o">::</span><span class="n">green</span><span class="p">,</span><span class="w"> </span><span class="n">pros</span><span class="o">::</span><span class="n">v5</span><span class="o">::</span><span class="n">MotorUnits</span><span class="o">::</span><span class="n">rotations</span><span class="p">);</span><span class="w"> </span><span class="c1">//port 4 w/ rotations</span>

<span class="p">}</span></pre>
</div></section>
Expand Down Expand Up @@ -2751,7 +2751,8 @@ <h3>
std::int8_t <a href="#ga715fb6eb00c706e6cc966bfb82570c9e" class="m-doc-self">_port</a>
<div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="motors_8hpp.html">&lt;pros/motors.hpp&gt;</a></div>
</h3>
<p><span></span></p>
<p>The port of the motor.</p>
<p>Negative ports indicate that the motor is reversed</p>
</div></section>
</section>
</div>
Expand Down
8 changes: 5 additions & 3 deletions xml/classpros_1_1v5_1_1Motor.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3151,12 +3151,14 @@ This function uses the following values of errno when an error state is reached:
<argsstring></argsstring>
<name>_port</name>
<briefdescription>
<para>The port of the motor. </para>
</briefdescription>
<detaileddescription>
<para>Negative ports indicate that the motor is reversed </para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="pros/motors.hpp" line="2377" column="13" bodyfile="pros/motors.hpp" bodystart="2377" bodyend="-1"/>
<location file="pros/motors.hpp" line="2380" column="13" bodyfile="pros/motors.hpp" bodystart="2380" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-func">
Expand Down Expand Up @@ -3213,7 +3215,7 @@ This function uses the following values of errno when an error state is reached:
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/>Motor<sp/>first_motor(1);<sp/>//Creates<sp/>a<sp/>motor<sp/>on<sp/>port<sp/>1<sp/>without<sp/>altering<sp/>gearset<sp/>or<sp/>encoder<sp/>units</highlight></codeline>
<codeline><highlight class="normal"><sp/>Motor<sp/>reversed_motor(-2);<sp/>//Creates<sp/>a<sp/>reversed<sp/>motor<sp/>on<sp/>port<sp/>1<sp/>port<sp/>1<sp/>without<sp/>altering<sp/>gearset<sp/>or<sp/>encoder<sp/>units</highlight></codeline>
<codeline><highlight class="normal"><sp/>Motor<sp/>blue_motor(3,<sp/>pros::v5::MotorGears::blue);<sp/>//Creates<sp/>a<sp/>motor<sp/>on<sp/>port<sp/>3<sp/>with<sp/>blue<sp/>gear<sp/>set</highlight></codeline>
<codeline><highlight class="normal"><sp/>Motor<sp/>rotations_motor(4,<sp/>pros::v5::MotorGears::green,<sp/>pros::v5::MotorUnits::rotations);<sp/>port<sp/>4<sp/>w/<sp/>rotations</highlight></codeline>
<codeline><highlight class="normal"><sp/>Motor<sp/>rotations_motor(4,<sp/>pros::v5::MotorGears::green,<sp/>pros::v5::MotorUnits::rotations);<sp/>//port<sp/>4<sp/>w/<sp/>rotations</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">}</highlight></codeline>
</programlisting> </para>
Expand Down Expand Up @@ -3280,7 +3282,7 @@ This function uses the following values of errno when an error state is reached:
<link refid="classpros_1_1v5_1_1AbstractMotor"/>
</node>
</collaborationgraph>
<location file="pros/motors.hpp" line="34" column="48" bodyfile="pros/motors.hpp" bodystart="34" bodyend="2378"/>
<location file="pros/motors.hpp" line="34" column="48" bodyfile="pros/motors.hpp" bodystart="34" bodyend="2381"/>
<listofallmembers>
<member refid="group__cpp-motors_1ga715fb6eb00c706e6cc966bfb82570c9e" prot="private" virt="non-virtual"><scope>pros::v5::Motor</scope><name>_port</name></member>
<member refid="group__cpp-motors_1ga3ac7359521b822775fbdc3a708f9e687" prot="public" virt="virtual"><scope>pros::v5::Motor</scope><name>brake</name></member>
Expand Down
16 changes: 11 additions & 5 deletions xml/classpros_1_1v5_1_1MotorGroup.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3057,13 +3057,19 @@ This function uses the following values of errno when an error state is reached:
<defval>0</defval>
</param>
<briefdescription>
<para>Gets the port of a motor in the motor group. </para>
<para>Gets the port of a motor in the motor group via index. </para>
</briefdescription>
<detaileddescription>
<para><verbatim> * \param index Optional parameter, 0 by default.
The zero indexed index of the motor in the motor group
</verbatim></para>
<para><simplesect kind="return"><para>The port of the motor at the specified index. The return value is negative if the corresponding motor is reversed </para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>index</parametername>
</parameternamelist>
<parameterdescription>
<para>Optional parameter, 0 by default. The zero indexed index of the motor in the motor group</para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>The port of the motor at the specified index. The return value is negative if the corresponding motor is reversed </para>
</simplesect>
</para>
</detaileddescription>
Expand Down
16 changes: 11 additions & 5 deletions xml/group__cpp-motor-group.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3057,13 +3057,19 @@ This function uses the following values of errno when an error state is reached:
<defval>0</defval>
</param>
<briefdescription>
<para>Gets the port of a motor in the motor group. </para>
<para>Gets the port of a motor in the motor group via index. </para>
</briefdescription>
<detaileddescription>
<para><verbatim> * \param index Optional parameter, 0 by default.
The zero indexed index of the motor in the motor group
</verbatim></para>
<para><simplesect kind="return"><para>The port of the motor at the specified index. The return value is negative if the corresponding motor is reversed </para>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>index</parametername>
</parameternamelist>
<parameterdescription>
<para>Optional parameter, 0 by default. The zero indexed index of the motor in the motor group</para>
</parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>The port of the motor at the specified index. The return value is negative if the corresponding motor is reversed </para>
</simplesect>
</para>
</detaileddescription>
Expand Down
10 changes: 6 additions & 4 deletions xml/group__cpp-motors.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3150,12 +3150,14 @@ This function uses the following values of errno when an error state is reached:
<argsstring></argsstring>
<name>_port</name>
<briefdescription>
<para>The port of the motor. </para>
</briefdescription>
<detaileddescription>
<para>Negative ports indicate that the motor is reversed </para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="pros/motors.hpp" line="2377" column="13" bodyfile="pros/motors.hpp" bodystart="2377" bodyend="-1"/>
<location file="pros/motors.hpp" line="2380" column="13" bodyfile="pros/motors.hpp" bodystart="2380" bodyend="-1"/>
</memberdef>
</sectiondef>
<sectiondef kind="func">
Expand Down Expand Up @@ -3212,7 +3214,7 @@ This function uses the following values of errno when an error state is reached:
<codeline><highlight class="normal"><sp/><sp/><sp/><sp/>Motor<sp/>first_motor(1);<sp/>//Creates<sp/>a<sp/>motor<sp/>on<sp/>port<sp/>1<sp/>without<sp/>altering<sp/>gearset<sp/>or<sp/>encoder<sp/>units</highlight></codeline>
<codeline><highlight class="normal"><sp/>Motor<sp/>reversed_motor(-2);<sp/>//Creates<sp/>a<sp/>reversed<sp/>motor<sp/>on<sp/>port<sp/>1<sp/>port<sp/>1<sp/>without<sp/>altering<sp/>gearset<sp/>or<sp/>encoder<sp/>units</highlight></codeline>
<codeline><highlight class="normal"><sp/>Motor<sp/>blue_motor(3,<sp/>pros::v5::MotorGears::blue);<sp/>//Creates<sp/>a<sp/>motor<sp/>on<sp/>port<sp/>3<sp/>with<sp/>blue<sp/>gear<sp/>set</highlight></codeline>
<codeline><highlight class="normal"><sp/>Motor<sp/>rotations_motor(4,<sp/>pros::v5::MotorGears::green,<sp/>pros::v5::MotorUnits::rotations);<sp/>port<sp/>4<sp/>w/<sp/>rotations</highlight></codeline>
<codeline><highlight class="normal"><sp/>Motor<sp/>rotations_motor(4,<sp/>pros::v5::MotorGears::green,<sp/>pros::v5::MotorUnits::rotations);<sp/>//port<sp/>4<sp/>w/<sp/>rotations</highlight></codeline>
<codeline></codeline>
<codeline><highlight class="normal">}</highlight></codeline>
</programlisting> </para>
Expand Down Expand Up @@ -3253,7 +3255,7 @@ This function uses the following values of errno when an error state is reached:
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="pros/motors.hpp" line="2380" column="19" declfile="pros/motors.hpp" declline="2380" declcolumn="19"/>
<location file="pros/motors.hpp" line="2383" column="19" declfile="pros/motors.hpp" declline="2383" declcolumn="19"/>
</memberdef>
<memberdef kind="function" id="group__cpp-motors_1gada0f69d38dd1f1e8af907dccaf48afb7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>const <ref refid="classpros_1_1v5_1_1Motor" kindref="compound">pros::Motor</ref></type>
Expand All @@ -3270,7 +3272,7 @@ This function uses the following values of errno when an error state is reached:
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="pros/motors.hpp" line="2381" column="19" declfile="pros/motors.hpp" declline="2381" declcolumn="19"/>
<location file="pros/motors.hpp" line="2384" column="19" declfile="pros/motors.hpp" declline="2384" declcolumn="19"/>
</memberdef>
</sectiondef>
<briefdescription>
Expand Down
4 changes: 2 additions & 2 deletions xml/motors_8hpp.xml
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="pros/motors.hpp" line="2380" column="19" declfile="pros/motors.hpp" declline="2380" declcolumn="19"/>
<location file="pros/motors.hpp" line="2383" column="19" declfile="pros/motors.hpp" declline="2383" declcolumn="19"/>
</memberdef>
<memberdef kind="function" id="group__cpp-motors_1gada0f69d38dd1f1e8af907dccaf48afb7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>const <ref refid="classpros_1_1v5_1_1Motor" kindref="compound">pros::Motor</ref></type>
Expand All @@ -212,7 +212,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="pros/motors.hpp" line="2381" column="19" declfile="pros/motors.hpp" declline="2381" declcolumn="19"/>
<location file="pros/motors.hpp" line="2384" column="19" declfile="pros/motors.hpp" declline="2384" declcolumn="19"/>
</memberdef>
</sectiondef>
<briefdescription>
Expand Down
4 changes: 2 additions & 2 deletions xml/namespacepros_1_1v5_1_1literals.xml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="pros/motors.hpp" line="2380" column="19" declfile="pros/motors.hpp" declline="2380" declcolumn="19"/>
<location file="pros/motors.hpp" line="2383" column="19" declfile="pros/motors.hpp" declline="2383" declcolumn="19"/>
</memberdef>
<memberdef kind="function" id="group__cpp-motors_1gada0f69d38dd1f1e8af907dccaf48afb7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>const <ref refid="classpros_1_1v5_1_1Motor" kindref="compound">pros::Motor</ref></type>
Expand All @@ -98,7 +98,7 @@
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="pros/motors.hpp" line="2381" column="19" declfile="pros/motors.hpp" declline="2381" declcolumn="19"/>
<location file="pros/motors.hpp" line="2384" column="19" declfile="pros/motors.hpp" declline="2384" declcolumn="19"/>
</memberdef>
<memberdef kind="function" id="namespacepros_1_1v5_1_1literals_1aaa943f214dd0f11174dfb5b4962a26be" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>const <ref refid="classpros_1_1v5_1_1Optical" kindref="compound">pros::Optical</ref></type>
Expand Down

0 comments on commit 2eaabb4

Please sign in to comment.