Update documentation

This commit is contained in:
Konstantin Lampalzer 2021-03-19 15:22:50 +01:00
parent dbe08c033a
commit cf7d60f002
No known key found for this signature in database
GPG key ID: 9A60A522835A2AD9
9 changed files with 360 additions and 6 deletions

View file

@ -168,6 +168,26 @@
<span id="lib-battery"></span><h1>Battery<a class="headerlink" href="#battery" title="Permalink to this headline"></a></h1>
<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.Battery.Battery">
<em class="property">class </em><code class="sig-prename descclassname">compLib.Battery.</code><code class="sig-name descname">Battery</code><a class="headerlink" href="#compLib.Battery.Battery" title="Permalink to this definition"></a></dt>
<dd><p>Used to interact with the battery</p>
<dl class="py method">
<dt id="compLib.Battery.Battery.percent">
<em class="property">static </em><code class="sig-name descname">percent</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; int<a class="headerlink" href="#compLib.Battery.Battery.percent" title="Permalink to this definition"></a></dt>
<dd><p>Get battery percentage</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Percentage between 0 and 100</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>int</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>