Skip to content

Commit

Permalink
Refreshed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sebi2k1
sebi2k1 committed Nov 8, 2022
1 parent 8106f69 commit b3f0f52
Show file tree
Hide file tree
Showing 11 changed files with 1,697 additions and 688 deletions.
51 changes: 4 additions & 47 deletions docs/classes/DatabaseService.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h1>DatabaseService Class</h1>


<div class="foundat">
Defined in: <a href="../files/socketcan.js.html#l203"><code>socketcan.js:203</code></a>
Defined in: <a href="../files/src_socketcan.ts.html#l284"><code>src&#x2F;socketcan.ts:284</code></a>
</div>

Module: <a href="../modules/Signals.html">Signals</a>
Expand Down Expand Up @@ -128,7 +128,7 @@ <h3 class="name"><code>DatabaseService</code></h3>
<div class="meta">
<p>
Defined in
<a href="../files/socketcan.js.html#l203"><code>socketcan.js:203</code></a>
<a href="../files/src_socketcan.ts.html#l284"><code>src&#x2F;socketcan.ts:284</code></a>
</p>


Expand Down Expand Up @@ -186,7 +186,6 @@ <h4>Returns:</h4>
<li class="api-class-tab index"><a href="#index">Index</a></li>

<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab attrs"><a href="#attrs">Attributes</a></li>
</ul>

<div>
Expand All @@ -205,15 +204,6 @@ <h3>Methods</h3>
</div>


<div class="index-section attrs">
<h3>Attributes</h3>

<ul class="index-list attrs">
<li class="index-item attr">
<a href="#attr_messages">messages</a>
</li>
</ul>
</div>

</div>

Expand Down Expand Up @@ -241,7 +231,7 @@ <h3 class="name"><code>send</code></h3>
<div class="meta">
<p>
Defined in
<a href="../files/socketcan.js.html#l279"><code>socketcan.js:279</code></a>
<a href="../files/src_socketcan.ts.html#l364"><code>src&#x2F;socketcan.ts:364</code></a>
</p>


Expand All @@ -264,7 +254,7 @@ <h4>Parameters:</h4>


<div class="param-description">
<p>Name of the message to generate</p>
<p>Name of the message to generate (indicate mux by append .MUX_VALUE in hex)</p>

</div>

Expand All @@ -278,39 +268,6 @@ <h4>Parameters:</h4>
</div>


<div id="attrs" class="api-class-tabpanel">
<h2 class="off-left">Attributes</h2>

<div id="attr_messages" class="attr item">
<a name="config_messages"></a>
<h3 class="name"><code>messages</code></h3>
<span class="type"><a href="../classes/Message.html" class="crosslink">Message</a></span>








<div class="meta">
<p>
Defined in
<a href="../files/socketcan.js.html#l216"><code>socketcan.js:216</code></a>
</p>


</div>

<div class="description">
<p>Named array of known messages. Accessible via index and name.</p>

</div>



</div>
</div>

</div>
</div>
Expand Down
81 changes: 57 additions & 24 deletions docs/classes/Message.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ <h1>Message Class</h1>


<div class="foundat">
Defined in: <a href="../files/socketcan.js.html#l134"><code>socketcan.js:134</code></a>
Defined in: <a href="../files/src_socketcan.ts.html#l198"><code>src&#x2F;socketcan.ts:198</code></a>
</div>

Module: <a href="../modules/Signals.html">Signals</a>
Expand Down Expand Up @@ -116,6 +116,9 @@ <h2 class="off-left">Item Index</h2>
<h3>Attributes</h3>

<ul class="index-list attrs">
<li class="index-item attr">
<a href="#attr_Boolean">Boolean</a>
</li>
<li class="index-item attr">
<a href="#attr_ext">ext</a>
</li>
Expand All @@ -129,13 +132,13 @@ <h3>Attributes</h3>
<a href="#attr_len">len</a>
</li>
<li class="index-item attr">
<a href="#attr_muxed">muxed</a>
<a href="#attr_mux">mux</a>
</li>
<li class="index-item attr">
<a href="#attr_name">name</a>
<a href="#attr_muxed">muxed</a>
</li>
<li class="index-item attr">
<a href="#attr_signals">signals</a>
<a href="#attr_name">name</a>
</li>
</ul>
</div>
Expand All @@ -147,6 +150,36 @@ <h3>Attributes</h3>
<div id="attrs" class="api-class-tabpanel">
<h2 class="off-left">Attributes</h2>

<div id="attr_Boolean" class="attr item">
<a name="config_Boolean"></a>
<h3 class="name"><code>Boolean</code></h3>
<span class="type"></span>



<span class="flag final">final</span>





<div class="meta">
<p>
Defined in
<a href="../files/src_socketcan.ts.html#l266"><code>src&#x2F;socketcan.ts:266</code></a>
</p>


</div>

<div class="description">
<p>Named information to inform that the frame is CAN_FD format .</p>

</div>



</div>
<div id="attr_ext" class="attr item">
<a name="config_ext"></a>
<h3 class="name"><code>ext</code></h3>
Expand All @@ -163,7 +196,7 @@ <h3 class="name"><code>ext</code></h3>
<div class="meta">
<p>
Defined in
<a href="../files/socketcan.js.html#l147"><code>socketcan.js:147</code></a>
<a href="../files/src_socketcan.ts.html#l220"><code>src&#x2F;socketcan.ts:220</code></a>
</p>


Expand Down Expand Up @@ -193,7 +226,7 @@ <h3 class="name"><code>id</code></h3>
<div class="meta">
<p>
Defined in
<a href="../files/socketcan.js.html#l140"><code>socketcan.js:140</code></a>
<a href="../files/src_socketcan.ts.html#l213"><code>src&#x2F;socketcan.ts:213</code></a>
</p>


Expand Down Expand Up @@ -223,7 +256,7 @@ <h3 class="name"><code>interval</code></h3>
<div class="meta">
<p>
Defined in
<a href="../files/socketcan.js.html#l169"><code>socketcan.js:169</code></a>
<a href="../files/src_socketcan.ts.html#l242"><code>src&#x2F;socketcan.ts:242</code></a>
</p>


Expand Down Expand Up @@ -253,7 +286,7 @@ <h3 class="name"><code>len</code></h3>
<div class="meta">
<p>
Defined in
<a href="../files/socketcan.js.html#l161"><code>socketcan.js:161</code></a>
<a href="../files/src_socketcan.ts.html#l234"><code>src&#x2F;socketcan.ts:234</code></a>
</p>


Expand All @@ -267,9 +300,9 @@ <h3 class="name"><code>len</code></h3>


</div>
<div id="attr_muxed" class="attr item">
<a name="config_muxed"></a>
<h3 class="name"><code>muxed</code></h3>
<div id="attr_mux" class="attr item">
<a name="config_mux"></a>
<h3 class="name"><code>mux</code></h3>
<span class="type"></span>


Expand All @@ -283,23 +316,23 @@ <h3 class="name"><code>muxed</code></h3>
<div class="meta">
<p>
Defined in
<a href="../files/socketcan.js.html#l177"><code>socketcan.js:177</code></a>
<a href="../files/src_socketcan.ts.html#l258"><code>src&#x2F;socketcan.ts:258</code></a>
</p>


</div>

<div class="description">
<p>This is tells us the message is mutliplexed.</p>
<p>Multiplexor parameter (just one supported right now).</p>

</div>



</div>
<div id="attr_name" class="attr item">
<a name="config_name"></a>
<h3 class="name"><code>name</code></h3>
<div id="attr_muxed" class="attr item">
<a name="config_muxed"></a>
<h3 class="name"><code>muxed</code></h3>
<span class="type"></span>


Expand All @@ -313,24 +346,24 @@ <h3 class="name"><code>name</code></h3>
<div class="meta">
<p>
Defined in
<a href="../files/socketcan.js.html#l154"><code>socketcan.js:154</code></a>
<a href="../files/src_socketcan.ts.html#l250"><code>src&#x2F;socketcan.ts:250</code></a>
</p>


</div>

<div class="description">
<p>Symbolic name</p>
<p>This tells us the message is mutliplexed.</p>

</div>



</div>
<div id="attr_signals" class="attr item">
<a name="config_signals"></a>
<h3 class="name"><code>signals</code></h3>
<span class="type"><a href="../classes/Signal.html" class="crosslink">Signal</a></span>
<div id="attr_name" class="attr item">
<a name="config_name"></a>
<h3 class="name"><code>name</code></h3>
<span class="type"></span>



Expand All @@ -343,14 +376,14 @@ <h3 class="name"><code>signals</code></h3>
<div class="meta">
<p>
Defined in
<a href="../files/socketcan.js.html#l185"><code>socketcan.js:185</code></a>
<a href="../files/src_socketcan.ts.html#l227"><code>src&#x2F;socketcan.ts:227</code></a>
</p>


</div>

<div class="description">
<p>Named array of signals within this message. Accessible via index and name.</p>
<p>Symbolic name</p>

</div>

Expand Down
Loading

0 comments on commit b3f0f52

Please sign in to comment.