jalr/OpenRGB
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update even more file header comments to standardized new format

Browse source
This commit is contained in:
Adam Honse 2024-05-03 11:51:20 -05:00
parent 200b8e3a24
commit a3066db16c
31 changed files with 284 additions and 152 deletions
Download patch file Download diff file Expand all files Collapse all files

6
KeyboardLayoutManager/KeyboardLayoutManager.cpp
View file

@ -1,11 +1,13 @@
/*---------------------------------------------------------------------*\ /*---------------------------------------------------------*\
| KeyboardLayoutManager.cpp | | KeyboardLayoutManager.cpp |
| | | |
| Helper library to produce keyboard layouts | | Helper library to produce keyboard layouts |
| | | |
| Chris M (Dr_No) 04 Feb 2023 | | Chris M (Dr_No) 04 Feb 2023 |
| | | |
\*---------------------------------------------------------------------*/ | This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "LogManager.h" #include "LogManager.h"
#include "KeyboardLayoutManager.h" #include "KeyboardLayoutManager.h"

7
KeyboardLayoutManager/KeyboardLayoutManager.h
View file

@ -1,11 +1,14 @@
/*---------------------------------------------------------------------*\ /*---------------------------------------------------------*\
| KeyboardLayoutManager.h | | KeyboardLayoutManager.h |
| | | |
| Helper library to produce keyboard layouts | | Helper library to produce keyboard layouts |
| | | |
| Chris M (Dr_No) 04 Feb 2023 | | Chris M (Dr_No) 04 Feb 2023 |
| | | |
\*---------------------------------------------------------------------*/ | This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once #pragma once
#include <map> #include <map>

14
RGBController/RGBController.cpp
View file

@ -1,5 +1,17 @@
#include "RGBController.h" /*---------------------------------------------------------*\
| RGBController.cpp |
| |
| OpenRGB's RGB controller hardware abstration layer, |
| provides a generic representation of an RGB device |
| |
| Adam Honse (CalcProgrammer1) 02 Jun 2019 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <cstring> #include <cstring>
#include "RGBController.h"
using namespace std::chrono_literals; using namespace std::chrono_literals;

13
RGBController/RGBController.h
View file

@ -1,11 +1,14 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| RGBController.h | | RGBController.h |
| | | |
| Definitions and types for generic RGB | | OpenRGB's RGB controller hardware abstration layer, |
| lighting controller interface | | provides a generic representation of an RGB device |
| | | |
| Adam Honse (CalcProgrammer1) 6/2/2019 | | Adam Honse (CalcProgrammer1) 02 Jun 2019 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once #pragma once

11
RGBController/RGBControllerKeyNames.cpp
View file

@ -1,13 +1,14 @@
/*-------------------------------------------------------------------*\ /*---------------------------------------------------------*\
| RGBControllerKeyNames.cpp | | RGBControllerKeyNames.cpp |
| | | |
| This is the canonical list of Key Names to be used in | | List of standardized names to represent keyboard keys |
| keyboard and other device initialisations to avoid redundant | | when naming LEDs on keyboard devices |
| string literal declarations |
| | | |
| Chris M (Dr_No) 25 Jan 2022 | | Chris M (Dr_No) 25 Jan 2022 |
| | | |
\*-------------------------------------------------------------------*/ | This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "RGBControllerKeyNames.h" #include "RGBControllerKeyNames.h"

11
RGBController/RGBControllerKeyNames.h
View file

@ -1,13 +1,14 @@
/*-------------------------------------------------------------------*\ /*---------------------------------------------------------*\
| RGBControllerKeyNames.h | | RGBControllerKeyNames.h |
| | | |
| This is the canonical list of Key Names to be used in | | List of standardized names to represent keyboard keys |
| keyboard and other device initialisations to avoid redundant | | when naming LEDs on keyboard devices |
| string literal declarations |
| | | |
| Chris M (Dr_No) 25 Jan 2022 | | Chris M (Dr_No) 25 Jan 2022 |
| | | |
\*-------------------------------------------------------------------*/ | This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once #pragma once

12
RGBController/RGBController_Dummy.cpp
View file

@ -1,10 +1,14 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| RGBController_Dummy.cpp | | RGBController_Dummy.cpp |
| | | |
| Generic RGB Interface Dummy Class | | Dummy RGBController that can mimic various devices for |
| development and test purposes |
| | | |
| Adam Honse (CalcProgrammer1) 2/25/2020 | | Adam Honse (CalcProgrammer1) 25 Feb 2020 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "RGBController_Dummy.h" #include "RGBController_Dummy.h"

12
RGBController/RGBController_Dummy.h
View file

@ -1,10 +1,14 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| RGBController_Dummy.h | | RGBController_Dummy.h |
| | | |
| Generic RGB Interface Dummy Class | | Dummy RGBController that can mimic various devices for |
| development and test purposes |
| | | |
| Adam Honse (CalcProgrammer1) 2/25/2020 | | Adam Honse (CalcProgrammer1) 25 Feb 2020 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once #pragma once

12
RGBController/RGBController_Network.cpp
View file

@ -1,10 +1,14 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| RGBController_Network.cpp | | RGBController_Network.cpp |
| | | |
| Generic RGB Interface Network Class | | RGBController implementation that represents a remote |
| RGBController instance from a connected OpenRGB server |
| | | |
| Adam Honse (CalcProgrammer1) 4/11/2020 | | Adam Honse (CalcProgrammer1) 11 Apr 2020 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <cstring> #include <cstring>

12
RGBController/RGBController_Network.h
View file

@ -1,10 +1,14 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| RGBController_Network.h | | RGBController_Network.h |
| | | |
| Generic RGB Interface Network Class | | RGBController implementation that represents a remote |
| RGBController instance from a connected OpenRGB server |
| | | |
| Adam Honse (CalcProgrammer1) 4/11/2020 | | Adam Honse (CalcProgrammer1) 11 Apr 2020 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once #pragma once

10
i2c_tools/i2c_tools.cpp
View file

@ -1,3 +1,13 @@
/*---------------------------------------------------------*\
| i2c_tools.cpp |
| |
| Utility functions for communicating with and reverse |
| engineering i2c devices |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "i2c_tools.h" #include "i2c_tools.h"
/******************************************************************************************\ /******************************************************************************************\

10
i2c_tools/i2c_tools.h
View file

@ -1,3 +1,13 @@
/*---------------------------------------------------------*\
| i2c_tools.h |
| |
| Utility functions for communicating with and reverse |
| engineering i2c devices |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <string> #include <string>
#include "i2c_smbus.h" #include "i2c_smbus.h"

6
interop/DeviceGuard.cpp
View file

@ -3,10 +3,12 @@
| | | |
| An abstract interface for acquiring and releasing | | An abstract interface for acquiring and releasing |
| a guard on a device, serving as a foundation for | | a guard on a device, serving as a foundation for |
| implementing device-specific synchronization mechanisms. | | implementing device-specific synchronization mechanisms |
| | | |
| Evan Mulawski, 2023-09-05 | | Evan Mulawski 09 May 2023 |
| | | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#include "DeviceGuard.h" #include "DeviceGuard.h"

6
interop/DeviceGuard.h
View file

@ -3,10 +3,12 @@
| | | |
| An abstract interface for acquiring and releasing | | An abstract interface for acquiring and releasing |
| a guard on a device, serving as a foundation for | | a guard on a device, serving as a foundation for |
| implementing device-specific synchronization mechanisms. | | implementing device-specific synchronization mechanisms |
| | | |
| Evan Mulawski, 2023-09-05 | | Evan Mulawski 09 May 2023 |
| | | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#pragma once #pragma once

8
interop/DeviceGuardLock.cpp
View file

@ -2,11 +2,13 @@
| DeviceGuardLock.cpp | | DeviceGuardLock.cpp |
| | | |
| Represents a lock for a device guard, ensuring | | Represents a lock for a device guard, ensuring |
| exclusive access to a device when acquired | | exclusive access to a device when acquired and |
| and releasing it when destroyed. | | releasing it when destroyed |
| | | |
| Evan Mulawski, 2023-09-05 | | Evan Mulawski 09 May 2023 |
| | | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#include "DeviceGuardLock.h" #include "DeviceGuardLock.h"

8
interop/DeviceGuardLock.h
View file

@ -2,11 +2,13 @@
| DeviceGuardLock.h | | DeviceGuardLock.h |
| | | |
| Represents a lock for a device guard, ensuring | | Represents a lock for a device guard, ensuring |
| exclusive access to a device when acquired | | exclusive access to a device when acquired and |
| and releasing it when destroyed. | | releasing it when destroyed |
| | | |
| Evan Mulawski, 2023-09-05 | | Evan Mulawski 09 May 2023 |
| | | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#pragma once #pragma once

6
interop/DeviceGuardManager.cpp
View file

@ -3,10 +3,12 @@
| | | |
| Responsible for managing a DeviceGuard implementation, | | Responsible for managing a DeviceGuard implementation, |
| allowing clients to wait for exclusive access to a | | allowing clients to wait for exclusive access to a |
| device using the DeviceGuardLock it provides. | | device using the DeviceGuardLock it provides |
| | | |
| Evan Mulawski, 2023-09-05 | | Evan Mulawski 09 May 2023 |
| | | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#include "DeviceGuardManager.h" #include "DeviceGuardManager.h"

6
interop/DeviceGuardManager.h
View file

@ -3,10 +3,12 @@
| | | |
| Responsible for managing a DeviceGuard implementation, | | Responsible for managing a DeviceGuard implementation, |
| allowing clients to wait for exclusive access to a | | allowing clients to wait for exclusive access to a |
| device using the DeviceGuardLock it provides. | | device using the DeviceGuardLock it provides |
| | | |
| Evan Mulawski, 2023-09-05 | | Evan Mulawski 09 May 2023 |
| | | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#pragma once #pragma once

10
net_port/net_port.cpp
View file

@ -1,10 +1,14 @@
/*---------------------------------------------------------*\ /*---------------------------------------------------------*\
| net_port.cpp |
| |
| Cross Platform Network Library for Windows and Linux | | Cross Platform Network Library for Windows and Linux |
| This library provides access to TCP and UDP ports with | | This library provides access to TCP and UDP ports with |
| a common API for both Windows and Linux systems. It | | a common API for both Windows and Linux systems |
| features read and write |
| | | |
| Adam Honse (calcprogrammer1@gmail.com), 12/15/2016 | | Adam Honse (calcprogrammer1@gmail.com) 15 Dec 2016 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#include "net_port.h" #include "net_port.h"

15
net_port/net_port.h
View file

@ -1,14 +1,17 @@
/*---------------------------------------------------------*\ /*---------------------------------------------------------*\
| net_port.h |
| |
| Cross Platform Network Library for Windows and Linux | | Cross Platform Network Library for Windows and Linux |
| This library provides access to TCP and UDP ports with | | This library provides access to TCP and UDP ports with |
| a common API for both Windows and Linux systems. It | | a common API for both Windows and Linux systems |
| features read and write |
| | | |
| Adam Honse (calcprogrammer1@gmail.com), 12/15/2016 | | Adam Honse (calcprogrammer1@gmail.com) 15 Dec 2016 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#ifndef NET_PORT_H #pragma once
#define NET_PORT_H
#include <vector> #include <vector>
@ -88,5 +91,3 @@ private:
sockaddr addrDest; sockaddr addrDest;
addrinfo* result_list; addrinfo* result_list;
}; };
#endif

5
scsiapi/scsiapi.h
View file

@ -3,7 +3,10 @@
| | | |
| Cross-platform SCSI access library | | Cross-platform SCSI access library |
| | | |
| Adam Honse <calcprogrammer1@gmail.com> 7/28/2023 | | Adam Honse (calcprogrammer1@gmail.com) 28 Jul 2023 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#pragma once #pragma once

5
scsiapi/scsiapi_linux.c
View file

@ -4,7 +4,10 @@
| Cross-platform SCSI access library | | Cross-platform SCSI access library |
| Linux implementation | | Linux implementation |
| | | |
| Adam Honse <calcprogrammer1@gmail.com> 7/28/2023 | | Adam Honse (calcprogrammer1@gmail.com) 28 Jul 2023 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#pragma once #pragma once

5
scsiapi/scsiapi_macos.c
View file

@ -4,7 +4,10 @@
| Cross-platform SCSI access library | | Cross-platform SCSI access library |
| MacOS implementation (NON-FUNCTIONAL) | | MacOS implementation (NON-FUNCTIONAL) |
| | | |
| Adam Honse <calcprogrammer1@gmail.com> 7/28/2023 | | Adam Honse (calcprogrammer1@gmail.com) 28 Jul 2023 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#pragma once #pragma once

5
scsiapi/scsiapi_windows.c
View file

@ -4,7 +4,10 @@
| Cross-platform SCSI access library | | Cross-platform SCSI access library |
| Windows implementation | | Windows implementation |
| | | |
| Adam Honse <calcprogrammer1@gmail.com> 7/28/2023 | | Adam Honse (calcprogrammer1@gmail.com) 28 Jul 2023 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#pragma once #pragma once

10
serial_port/find_usb_serial_port.h
View file

@ -1,3 +1,13 @@
/*---------------------------------------------------------*\
| find_usb_serial_port.h |
| |
| Finds the serial port path(s) of USB serial port devices|
| given the USB VID and PID of the device |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <stdio.h> #include <stdio.h>
#include <stdlib.h> #include <stdlib.h>

10
serial_port/find_usb_serial_port_linux.cpp
View file

@ -1,3 +1,13 @@
/*---------------------------------------------------------*\
| find_usb_serial_port_linux.cpp |
| |
| Finds the serial port path(s) of USB serial port devices|
| given the USB VID and PID of the device |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "find_usb_serial_port.h" #include "find_usb_serial_port.h"
#include <unistd.h> #include <unistd.h>

10
serial_port/find_usb_serial_port_win.cpp
View file

@ -1,3 +1,13 @@
/*---------------------------------------------------------*\
| find_usb_serial_port_win.cpp |
| |
| Finds the serial port path(s) of USB serial port devices|
| given the USB VID and PID of the device |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "find_usb_serial_port.h" #include "find_usb_serial_port.h"
#include <initguid.h> #include <initguid.h>

10
serial_port/serial_port.cpp
View file

@ -1,10 +1,14 @@
/*---------------------------------------------------------*\ /*---------------------------------------------------------*\
| serial_port.cpp |
| |
| Cross Platform Serial COM Library for Windows and Linux | | Cross Platform Serial COM Library for Windows and Linux |
| This library provides access to serial ports with a | | This library provides access to serial ports with a |
| common API for both Windows and Linux systems. It | | common API for both Windows and Linux systems |
| features read and write as well as tx/rx buffer flush. |
| | | |
| Adam Honse (calcprogrammer1@gmail.com), 1/21/2013 | | Adam Honse (calcprogrammer1@gmail.com) 21 Jan 2013 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#include "serial_port.h" #include "serial_port.h"

10
serial_port/serial_port.h
View file

@ -1,10 +1,14 @@
/*---------------------------------------------------------*\ /*---------------------------------------------------------*\
| serial_port.h |
| |
| Cross Platform Serial COM Library for Windows and Linux | | Cross Platform Serial COM Library for Windows and Linux |
| This library provides access to serial ports with a | | This library provides access to serial ports with a |
| common API for both Windows and Linux systems. It | | common API for both Windows and Linux systems |
| features read and write as well as tx/rx buffer flush. |
| | | |
| Adam Honse (calcprogrammer1@gmail.com), 1/21/2013 | | Adam Honse (calcprogrammer1@gmail.com) 21 Jan 2013 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/ \*---------------------------------------------------------*/
#ifndef SERIAL_PORT_H #ifndef SERIAL_PORT_H

10
super_io/super_io.cpp
View file

@ -1,10 +1,14 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| super_io.cpp | | super_io.cpp |
| | | |
| Functions for interfacing with Super-IO | | Functions for interfacing with Super-IO |
| | | |
| Adam Honse (CalcProgrammer1) 2/11/2020 | | Adam Honse (CalcProgrammer1) 11 Feb 2020 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "super_io.h" #include "super_io.h"
#ifdef WIN32 #ifdef WIN32

11
super_io/super_io.h
View file

@ -1,10 +1,13 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| super_io.h | | super_io.cpp |
| | | |
| Functions for interfacing with Super-IO | | Functions for interfacing with Super-IO |
| | | |
| Adam Honse (CalcProgrammer1) 2/11/2020 | | Adam Honse (CalcProgrammer1) 11 Feb 2020 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
/******************************************************************************************\ /******************************************************************************************\
* * * *