From f4dbc2dbf08667ba733207b0ceec451b5ccbbaad Mon Sep 17 00:00:00 2001 From: Erik Benoist Date: Sun, 12 Nov 2017 11:55:42 -0600 Subject: [PATCH] Check in latest docs --- docs/html/libblinkstick_8h.html | 4 ++-- docs/html/libblinkstick_8h_source.html | 2 +- docs/html/structblinkstick__device.html | 2 +- docs/latex/libblinkstick_8h.tex | 4 ++-- docs/latex/structblinkstick__device.tex | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/html/libblinkstick_8h.html b/docs/html/libblinkstick_8h.html index 321ebb6..f7e7ca8 100644 --- a/docs/html/libblinkstick_8h.html +++ b/docs/html/libblinkstick_8h.html @@ -126,7 +126,7 @@

-

A 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 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.

@@ -183,7 +183,7 @@

-

Given a count will return a pointer array of blinkstick devices.

+

Given a count will return a pointer array of blinkstick devices. This will abort if the number found is less than the given count.

diff --git a/docs/html/libblinkstick_8h_source.html b/docs/html/libblinkstick_8h_source.html index 249b37b..41bc588 100644 --- a/docs/html/libblinkstick_8h_source.html +++ b/docs/html/libblinkstick_8h_source.html @@ -67,7 +67,7 @@
libblinkstick.h
-Go to the documentation of this file.
1 #include <hidapi/hidapi.h>
2 #include <stdbool.h>
3 #include <stdio.h>
4 #include <stdlib.h>
5 #include <string.h>
6 #include <stdarg.h>
7 
23 static int const BLINKSTICK_VENDOR_ID = 8352; //"0X20A0";
24 static int const BLINKSTICK_PRODUCT_ID = 16869; //"0X41E5";
25 
26 static int const BLINKSTICK_SINGLE_LED_MSG_SIZE = 4;
27 static int const BLINKSTICK_INDEXED_LED_MSG_PACKET_SIZE = 6;
28 
35 typedef struct blinkstick_device { hid_device* handle; } blinkstick_device;
36 
41 blinkstick_device** blinkstick_find_many(int count);
42 
47 blinkstick_device* blinkstick_find();
48 
53 void blinkstick_set_color(blinkstick_device* device,
54  int index,
55  int red,
56  int green,
57  int blue);
58 
64 void blinkstick_off(blinkstick_device* device, int index);
65 
66 // Turns on debug logging.
67 void blinkstick_debug();
68 
72 void blinkstick_destroy(blinkstick_device* device);
blinkstick_device
struct blinkstick_device blinkstick_device
+Go to the documentation of this file.
1 #include <hidapi/hidapi.h>
2 #include <stdbool.h>
3 #include <stdio.h>
4 #include <stdlib.h>
5 #include <string.h>
6 #include <stdarg.h>
7 
23 static int const BLINKSTICK_VENDOR_ID = 8352; //"0X20A0";
24 static int const BLINKSTICK_PRODUCT_ID = 16869; //"0X41E5";
25 
26 static int const BLINKSTICK_SINGLE_LED_MSG_SIZE = 4;
27 static int const BLINKSTICK_INDEXED_LED_MSG_PACKET_SIZE = 6;
28 
35 typedef struct blinkstick_device { hid_device* handle; } blinkstick_device;
36 
42 blinkstick_device** blinkstick_find_many(int count);
43 
48 blinkstick_device* blinkstick_find();
49 
54 void blinkstick_set_color(blinkstick_device* device,
55  int index,
56  int red,
57  int green,
58  int blue);
59 
65 void blinkstick_off(blinkstick_device* device, int index);
66 
67 // Turns on debug logging.
68 void blinkstick_debug();
69 
73 void blinkstick_destroy(blinkstick_device* device);
blinkstick_device
struct blinkstick_device blinkstick_device
blinkstick_find
blinkstick_device * blinkstick_find()
Definition: libblinkstick.c:68
blinkstick_find_many
blinkstick_device ** blinkstick_find_many(int count)
Definition: libblinkstick.c:37
blinkstick_device
Definition: libblinkstick.h:35
diff --git a/docs/html/structblinkstick__device.html b/docs/html/structblinkstick__device.html index 406b1e7..112a59a 100644 --- a/docs/html/structblinkstick__device.html +++ b/docs/html/structblinkstick__device.html @@ -76,7 +76,7 @@  

Detailed Description

-

A 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 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: diff --git a/docs/latex/libblinkstick_8h.tex b/docs/latex/libblinkstick_8h.tex index 8004aa9..18232f7 100644 --- a/docs/latex/libblinkstick_8h.tex +++ b/docs/latex/libblinkstick_8h.tex @@ -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}} @@ -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()}} diff --git a/docs/latex/structblinkstick__device.tex b/docs/latex/structblinkstick__device.tex index ae4c641..138278c 100644 --- a/docs/latex/structblinkstick__device.tex +++ b/docs/latex/structblinkstick__device.tex @@ -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