Update documentation

This commit is contained in:
Konstantin Lampalzer 2021-01-16 02:12:23 +01:00
parent d555d55b2c
commit f7a7dd37ed
No known key found for this signature in database
GPG key ID: 9A60A522835A2AD9
13 changed files with 60 additions and 60 deletions

View file

@ -165,12 +165,12 @@
<div class="section" id="class-documentation">
<h2>Class Documentation<a class="headerlink" href="#class-documentation" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt id="compLIB.Buzzer.Buzzer">
<em class="property">class </em><code class="sig-prename descclassname">compLIB.Buzzer.</code><code class="sig-name descname">Buzzer</code><a class="headerlink" href="#compLIB.Buzzer.Buzzer" title="Permalink to this definition"></a></dt>
<dt id="compLib.Buzzer.Buzzer">
<em class="property">class </em><code class="sig-prename descclassname">compLib.Buzzer.</code><code class="sig-name descname">Buzzer</code><a class="headerlink" href="#compLib.Buzzer.Buzzer" title="Permalink to this definition"></a></dt>
<dd><p>Used to interact with the buzzer</p>
<dl class="py method">
<dt id="compLIB.Buzzer.Buzzer.set">
<em class="property">static </em><code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">on</span><span class="p">:</span> <span class="n">bool</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLIB.Buzzer.Buzzer.set" title="Permalink to this definition"></a></dt>
<dt id="compLib.Buzzer.Buzzer.set">
<em class="property">static </em><code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">on</span><span class="p">:</span> <span class="n">bool</span></em><span class="sig-paren">)</span><a class="headerlink" href="#compLib.Buzzer.Buzzer.set" title="Permalink to this definition"></a></dt>
<dd><p>Turn the buzzer on / off</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -187,7 +187,7 @@
<div class="section" id="turning-buzzer-on-and-off">
<h3>Turning buzzer on and off<a class="headerlink" href="#turning-buzzer-on-and-off" title="Permalink to this headline"></a></h3>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">time</span>
<span class="kn">from</span> <span class="nn">compLIB.Buzzer</span> <span class="kn">import</span> <span class="n">Buzzer</span>
<span class="kn">from</span> <span class="nn">compLib.Buzzer</span> <span class="kn">import</span> <span class="n">Buzzer</span>
<span class="n">Buzzer</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>