Skip to content

Commit

Permalink
Check in latest docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ebenoist
ebenoist committed Nov 12, 2017
1 parent fb27905 commit f4dbc2d
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/html/libblinkstick_8h.html
View file
Expand Up @@ -126,7 +126,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#afec7f37c4f6d0909ebdd025c
</tr>
</table>
</div><div class="memdoc">
<p>A <a class="el" href="structblinkstick__device.html">blinkstick_device</a> holds a pointer to the hid device and is used when setting colors, modes, or turning the device off. Construct this device by using find_blinksticks and free it with destroy_blinkstick </p>
<p>A <a class="el" href="structblinkstick__device.html">blinkstick_device</a> holds a pointer to the hid device and is used when setting colors, modes, or turning the device off. Construct this device by using blinkstick_find and free it with blinkstick_destroy. </p>

</div>
</div>
Expand Down Expand Up @@ -183,7 +183,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#acfbb8d876cba394d9434a2cb
</tr>
</table>
</div><div class="memdoc">
<p>Given a count will return a pointer array of blinkstick devices. </p>
<p>Given a count will return a pointer array of blinkstick devices. This will abort if the number found is less than the given count. </p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/libblinkstick_8h_source.html
View file
Expand Up @@ -67,7 +67,7 @@
<div class="title">libblinkstick.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="libblinkstick_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#include &lt;hidapi/hidapi.h&gt;</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &lt;stdbool.h&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;stdio.h&gt;</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;stdlib.h&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;string.h&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;stdarg.h&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">static</span> <span class="keywordtype">int</span> <span class="keyword">const</span> BLINKSTICK_VENDOR_ID = 8352; <span class="comment">//&quot;0X20A0&quot;;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">static</span> <span class="keywordtype">int</span> <span class="keyword">const</span> BLINKSTICK_PRODUCT_ID = 16869; <span class="comment">//&quot;0X41E5&quot;;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">static</span> <span class="keywordtype">int</span> <span class="keyword">const</span> BLINKSTICK_SINGLE_LED_MSG_SIZE = 4;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">static</span> <span class="keywordtype">int</span> <span class="keyword">const</span> BLINKSTICK_INDEXED_LED_MSG_PACKET_SIZE = 6;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structblinkstick__device.html"> 35</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structblinkstick__device.html">blinkstick_device</a> { hid_device* handle; } <a class="code" href="libblinkstick_8h.html#afec7f37c4f6d0909ebdd025c714397a8">blinkstick_device</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<a class="code" href="structblinkstick__device.html">blinkstick_device</a>** <a class="code" href="libblinkstick_8h.html#acfbb8d876cba394d9434a2cbd3d9c06f">blinkstick_find_many</a>(<span class="keywordtype">int</span> count);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<a class="code" href="structblinkstick__device.html">blinkstick_device</a>* <a class="code" href="libblinkstick_8h.html#ab13232f2ff6cff7c020533ce744b1b4e">blinkstick_find</a>();</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keywordtype">void</span> <a class="code" href="libblinkstick_8h.html#ac6209d37adaed9cd7b016bde5490a9e4">blinkstick_set_color</a>(<a class="code" href="structblinkstick__device.html">blinkstick_device</a>* device,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">int</span> index,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">int</span> red,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">int</span> green,</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">int</span> blue);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keywordtype">void</span> <a class="code" href="libblinkstick_8h.html#a1b9476d117feba688ab2b8d305ce7633">blinkstick_off</a>(<a class="code" href="structblinkstick__device.html">blinkstick_device</a>* device, <span class="keywordtype">int</span> index);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment">// Turns on debug logging.</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="keywordtype">void</span> blinkstick_debug();</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="keywordtype">void</span> <a class="code" href="libblinkstick_8h.html#a31a61d714c9bd52c47cd9bad5f585b92">blinkstick_destroy</a>(<a class="code" href="structblinkstick__device.html">blinkstick_device</a>* device);</div><div class="ttc" id="libblinkstick_8h_html_afec7f37c4f6d0909ebdd025c714397a8"><div class="ttname"><a href="libblinkstick_8h.html#afec7f37c4f6d0909ebdd025c714397a8">blinkstick_device</a></div><div class="ttdeci">struct blinkstick_device blinkstick_device</div></div>
<a href="libblinkstick_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#include &lt;hidapi/hidapi.h&gt;</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &lt;stdbool.h&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;stdio.h&gt;</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;stdlib.h&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;string.h&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;stdarg.h&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">static</span> <span class="keywordtype">int</span> <span class="keyword">const</span> BLINKSTICK_VENDOR_ID = 8352; <span class="comment">//&quot;0X20A0&quot;;</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">static</span> <span class="keywordtype">int</span> <span class="keyword">const</span> BLINKSTICK_PRODUCT_ID = 16869; <span class="comment">//&quot;0X41E5&quot;;</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">static</span> <span class="keywordtype">int</span> <span class="keyword">const</span> BLINKSTICK_SINGLE_LED_MSG_SIZE = 4;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">static</span> <span class="keywordtype">int</span> <span class="keyword">const</span> BLINKSTICK_INDEXED_LED_MSG_PACKET_SIZE = 6;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structblinkstick__device.html"> 35</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structblinkstick__device.html">blinkstick_device</a> { hid_device* handle; } <a class="code" href="libblinkstick_8h.html#afec7f37c4f6d0909ebdd025c714397a8">blinkstick_device</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<a class="code" href="structblinkstick__device.html">blinkstick_device</a>** <a class="code" href="libblinkstick_8h.html#acfbb8d876cba394d9434a2cbd3d9c06f">blinkstick_find_many</a>(<span class="keywordtype">int</span> count);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<a class="code" href="structblinkstick__device.html">blinkstick_device</a>* <a class="code" href="libblinkstick_8h.html#ab13232f2ff6cff7c020533ce744b1b4e">blinkstick_find</a>();</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="keywordtype">void</span> <a class="code" href="libblinkstick_8h.html#ac6209d37adaed9cd7b016bde5490a9e4">blinkstick_set_color</a>(<a class="code" href="structblinkstick__device.html">blinkstick_device</a>* device,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">int</span> index,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordtype">int</span> red,</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">int</span> green,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">int</span> blue);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="keywordtype">void</span> <a class="code" href="libblinkstick_8h.html#a1b9476d117feba688ab2b8d305ce7633">blinkstick_off</a>(<a class="code" href="structblinkstick__device.html">blinkstick_device</a>* device, <span class="keywordtype">int</span> index);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;<span class="comment">// Turns on debug logging.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;<span class="keywordtype">void</span> blinkstick_debug();</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<span class="keywordtype">void</span> <a class="code" href="libblinkstick_8h.html#a31a61d714c9bd52c47cd9bad5f585b92">blinkstick_destroy</a>(<a class="code" href="structblinkstick__device.html">blinkstick_device</a>* device);</div><div class="ttc" id="libblinkstick_8h_html_afec7f37c4f6d0909ebdd025c714397a8"><div class="ttname"><a href="libblinkstick_8h.html#afec7f37c4f6d0909ebdd025c714397a8">blinkstick_device</a></div><div class="ttdeci">struct blinkstick_device blinkstick_device</div></div>
<div class="ttc" id="libblinkstick_8h_html_ab13232f2ff6cff7c020533ce744b1b4e"><div class="ttname"><a href="libblinkstick_8h.html#ab13232f2ff6cff7c020533ce744b1b4e">blinkstick_find</a></div><div class="ttdeci">blinkstick_device * blinkstick_find()</div><div class="ttdef"><b>Definition:</b> libblinkstick.c:68</div></div>
<div class="ttc" id="libblinkstick_8h_html_acfbb8d876cba394d9434a2cbd3d9c06f"><div class="ttname"><a href="libblinkstick_8h.html#acfbb8d876cba394d9434a2cbd3d9c06f">blinkstick_find_many</a></div><div class="ttdeci">blinkstick_device ** blinkstick_find_many(int count)</div><div class="ttdef"><b>Definition:</b> libblinkstick.c:37</div></div>
<div class="ttc" id="structblinkstick__device_html"><div class="ttname"><a href="structblinkstick__device.html">blinkstick_device</a></div><div class="ttdef"><b>Definition:</b> libblinkstick.h:35</div></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/structblinkstick__device.html
View file
Expand Up @@ -76,7 +76,7 @@
<tr class="separator:a4bb782abadc4e00570554c761a5e0768"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A <a class="el" href="structblinkstick__device.html">blinkstick_device</a> holds a pointer to the hid device and is used when setting colors, modes, or turning the device off. Construct this device by using find_blinksticks and free it with destroy_blinkstick </p>
<div class="textblock"><p>A <a class="el" href="structblinkstick__device.html">blinkstick_device</a> holds a pointer to the hid device and is used when setting colors, modes, or turning the device off. Construct this device by using blinkstick_find and free it with blinkstick_destroy. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/<a class="el" href="libblinkstick_8h_source.html">libblinkstick.h</a></li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/latex/libblinkstick_8h.tex
View file
Expand Up @@ -55,7 +55,7 @@ \subsection{Typedef Documentation}
\subsubsection{\texorpdfstring{blinkstick\+\_\+device}{blinkstick\_device}}
{\footnotesize\ttfamily typedef struct \hyperlink{structblinkstick__device}{blinkstick\+\_\+device} \hyperlink{structblinkstick__device}{blinkstick\+\_\+device}}

A \hyperlink{structblinkstick__device}{blinkstick\+\_\+device} holds a pointer to the hid device and is used when setting colors, modes, or turning the device off. Construct this device by using find\+\_\+blinksticks and free it with destroy\+\_\+blinkstick
A \hyperlink{structblinkstick__device}{blinkstick\+\_\+device} holds a pointer to the hid device and is used when setting colors, modes, or turning the device off. Construct this device by using blinkstick\+\_\+find and free it with blinkstick\+\_\+destroy.

\subsection{Function Documentation}
\mbox{\Hypertarget{libblinkstick_8h_a31a61d714c9bd52c47cd9bad5f585b92}\label{libblinkstick_8h_a31a61d714c9bd52c47cd9bad5f585b92}}
Expand All @@ -76,7 +76,7 @@ \subsubsection{\texorpdfstring{blinkstick\+\_\+find()}{blinkstick\_find()}}
\subsubsection{\texorpdfstring{blinkstick\+\_\+find\+\_\+many()}{blinkstick\_find\_many()}}
{\footnotesize\ttfamily \hyperlink{structblinkstick__device}{blinkstick\+\_\+device}$\ast$$\ast$ blinkstick\+\_\+find\+\_\+many (\begin{DoxyParamCaption}\item[{int}]{count }\end{DoxyParamCaption})}

Given a count will return a pointer array of blinkstick devices. \mbox{\Hypertarget{libblinkstick_8h_a1b9476d117feba688ab2b8d305ce7633}\label{libblinkstick_8h_a1b9476d117feba688ab2b8d305ce7633}}
Given a count will return a pointer array of blinkstick devices. This will abort if the number found is less than the given count. \mbox{\Hypertarget{libblinkstick_8h_a1b9476d117feba688ab2b8d305ce7633}\label{libblinkstick_8h_a1b9476d117feba688ab2b8d305ce7633}}
\index{libblinkstick.\+h@{libblinkstick.\+h}!blinkstick\+\_\+off@{blinkstick\+\_\+off}}
\index{blinkstick\+\_\+off@{blinkstick\+\_\+off}!libblinkstick.\+h@{libblinkstick.\+h}}
\subsubsection{\texorpdfstring{blinkstick\+\_\+off()}{blinkstick\_off()}}
Expand Down
2 changes: 1 addition & 1 deletion docs/latex/structblinkstick__device.tex
View file
Expand Up @@ -13,7 +13,7 @@ \subsection*{Public Attributes}


\subsection{Detailed Description}
A \hyperlink{structblinkstick__device}{blinkstick\+\_\+device} holds a pointer to the hid device and is used when setting colors, modes, or turning the device off. Construct this device by using find\+\_\+blinksticks and free it with destroy\+\_\+blinkstick
A \hyperlink{structblinkstick__device}{blinkstick\+\_\+device} holds a pointer to the hid device and is used when setting colors, modes, or turning the device off. Construct this device by using blinkstick\+\_\+find and free it with blinkstick\+\_\+destroy.

The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
\item
Expand Down

0 comments on commit f4dbc2d

Please sign in to comment.