From 17040eeed4fe06a1d2383b11e14713ac43b136bf Mon Sep 17 00:00:00 2001 From: Jens True Date: Tue, 30 Nov 2021 10:31:00 +0000 Subject: [PATCH] Tables and proper doxygen comments --- main.c | 123 ++++++++++++++++++++++++++++++--------------------------- 1 file changed, 65 insertions(+), 58 deletions(-) diff --git a/main.c b/main.c index 8411336..f888627 100644 --- a/main.c +++ b/main.c @@ -1,42 +1,45 @@ /** - ledcontroller-3bit - - This file is a fork of the LedController code. You will find - the original copyright notice below. - - Copyright (C) 2013 andmarios - http://www.andmarios.com - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - - - Original Copyright Notice: - - LedController - Copyright (C) 2011 jmrobles - http://robleshermoso.wordpress.com - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . + * @file main.c + * ledcontroller-3bit + * + * This file is a fork of the LedController code. You will find + * the original copyright notice below. + * + * @copyright + * Copyright (C) 2013 andmarios - http://www.andmarios.com + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * + * + * @copyright + * Original Copyright Notice: + * + * LedController + * Copyright (C) 2011 jmrobles - http://robleshermoso.wordpress.com + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ #include @@ -44,29 +47,33 @@ #include #include -#define VID 0x1294 -#define PID 0x1320 +#define VID 0x1294 /**< USB Vendor ID */ +#define PID 0x1320 /**< USB Product ID */ static struct libusb_device_handle *devh = NULL; /** - The device has a RGB LED, which has two states for each "sub-LED", - on and off. - The "sub-LEDs" are red, green and blue. - - Obviously there are 8 possible combinations for their state. - It seems there aren't bits mapped to each sub-LED, but instead - 3-bit values mapped to the 8 combinations. - - R G B Color Value - 0 0 0 off 0x0 - 0 0 1 blue 0x1 - 1 0 0 red 0x2 - 0 1 0 green 0x3 - 0 1 1 aqua 0x4 - 1 0 1 purple 0x5 - 1 1 0 yellow 0x6 (more of a mustard - green color) - 1 1 1 white 0x7 (a very blue-ish white) -*/ + * The device has a RGB LED, which has two states for each "sub-LED", + * on and off. + * The "sub-LEDs" are red, green and blue. + * + * Obviously there are 8 possible combinations for their state. + * It seems there aren't bits mapped to each sub-LED, but instead + * 3-bit values mapped to the 8 combinations. + * + * | R | G | B | Color | Value | Comment | + * | - | - | - | ------ | ----- | ------------------------------- | + * | 0 | 0 | 0 | off | 0x0 | | + * | 0 | 0 | 1 | blue | 0x1 | | + * | 1 | 0 | 0 | red | 0x2 | | + * | 0 | 1 | 0 | green | 0x3 | | + * | 0 | 1 | 1 | aqua | 0x4 | | + * | 1 | 0 | 1 | purple | 0x5 | | + * | 1 | 1 | 0 | yellow | 0x6 | more of a mustard - green color | + * | 1 | 1 | 1 | white | 0x7 | a very blue-ish white | + * + * @param argc POSIX number of parameters + * @param argv Array of parameters + */ int main(int argc, char **argv) { int ret; unsigned char code = 0;