Feature: Added Documentation in

This commit is contained in:
2024-03-01 10:44:15 +01:00
parent 2ee2b10c40
commit 16b9105873
51 changed files with 783 additions and 1187 deletions

View File

@@ -326,7 +326,7 @@
</div>
<div class="moduleDocstring">
<div><p class="undocumented">Undocumented</p></div>
<div><p>Some enums that are used within this package</p></div>
</div>
<div id="splitTables">
@@ -337,27 +337,27 @@
<td>Module</td>
<td><code><a href="fn_gen.enums.comm_method.html" class="internal-link" title="fn_gen.enums.comm_method">comm<wbr></wbr>_method</a></code></td>
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
<td>Communication Method Enumeration</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="fn_gen.enums.sweep_signal_type.html" class="internal-link" title="fn_gen.enums.sweep_signal_type">sweep<wbr></wbr>_signal<wbr></wbr>_type</a></code></td>
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
<td>Enumeration representing the different signal types used in a sweep</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="fn_gen.enums.sweep_spacing.html" class="internal-link" title="fn_gen.enums.sweep_spacing">sweep<wbr></wbr>_spacing</a></code></td>
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
<td>The spacings used for the sweep</td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="fn_gen.enums.sweep_trigger_slope.html" class="internal-link" title="fn_gen.enums.sweep_trigger_slope">sweep<wbr></wbr>_trigger<wbr></wbr>_slope</a></code></td>
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
<td>The different slopes used when the <code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep_trigger_source</a></code> is set to <code><a href="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.html#EXTERNAL" class="internal-link" title="fn_gen.enums.sweep_trigger_source.SweepTriggerSource.EXTERNAL">SweepTriggerSource.EXTERNAL</a></code></td>
</tr><tr class="module">
<td>Module</td>
<td><code><a href="fn_gen.enums.sweep_trigger_source.html" class="internal-link" title="fn_gen.enums.sweep_trigger_source">sweep<wbr></wbr>_trigger<wbr></wbr>_source</a></code></td>
<td><span class="undocumented">No module docstring; 1/1 class documented</span></td>
<td>The different sources available to trigger a sweep</td>
</tr>
</table>
@@ -378,7 +378,7 @@
<div class="container">
<a href="index.html">API Documentation</a> for fn_gen,
generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
23.9.1 at 2024-02-06 18:56:15.
23.9.1 at 2024-02-29 14:55:42.
</div>
<!-- Search related scripts needs to be loaded at the end of HTML