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

18
KeyboardLayoutManager/KeyboardLayoutManager.cpp
View file

@ -1,11 +1,13 @@
/*---------------------------------------------------------------------*\
| KeyboardLayoutManager.cpp |
| |
| Helper library to produce keyboard layouts |
| |
| Chris M (Dr_No) 04 Feb 2023 |
| |
\*---------------------------------------------------------------------*/
/*---------------------------------------------------------*\
| KeyboardLayoutManager.cpp |
| |
| Helper library to produce keyboard layouts |
| |
| 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 "KeyboardLayoutManager.h"

19
KeyboardLayoutManager/KeyboardLayoutManager.h
View file

@ -1,11 +1,14 @@
/*---------------------------------------------------------------------*\
| KeyboardLayoutManager.h |
| |
| Helper library to produce keyboard layouts |
| |
| Chris M (Dr_No) 04 Feb 2023 |
| |
\*---------------------------------------------------------------------*/
/*---------------------------------------------------------*\
| KeyboardLayoutManager.h |
| |
| Helper library to produce keyboard layouts |
| |
| Chris M (Dr_No) 04 Feb 2023 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#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 "RGBController.h"
using namespace std::chrono_literals;

19
RGBController/RGBController.h
View file

@ -1,11 +1,14 @@
/*-----------------------------------------*\
| RGBController.h |
| |
| Definitions and types for generic RGB |
| lighting controller interface |
| |
| Adam Honse (CalcProgrammer1) 6/2/2019 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| RGBController.h |
| |
| 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 |
\*---------------------------------------------------------*/
#pragma once

21
RGBController/RGBControllerKeyNames.cpp
View file

@ -1,13 +1,14 @@
/*-------------------------------------------------------------------*\
| RGBControllerKeyNames.cpp |
| |
| This is the canonical list of Key Names to be used in |
| keyboard and other device initialisations to avoid redundant |
| string literal declarations |
| |
| Chris M (Dr_No) 25 Jan 2022 |
| |
\*-------------------------------------------------------------------*/
/*---------------------------------------------------------*\
| RGBControllerKeyNames.cpp |
| |
| List of standardized names to represent keyboard keys |
| when naming LEDs on keyboard devices |
| |
| 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"

21
RGBController/RGBControllerKeyNames.h
View file

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

18
RGBController/RGBController_Dummy.cpp
View file

@ -1,10 +1,14 @@
/*-----------------------------------------*\
| RGBController_Dummy.cpp |
| |
| Generic RGB Interface Dummy Class |
| |
| Adam Honse (CalcProgrammer1) 2/25/2020 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| RGBController_Dummy.cpp |
| |
| Dummy RGBController that can mimic various devices for |
| development and test purposes |
| |
| 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"

18
RGBController/RGBController_Dummy.h
View file

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

18
RGBController/RGBController_Network.cpp
View file

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

18
RGBController/RGBController_Network.h
View file

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

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 "i2c_smbus.h"

12
interop/DeviceGuard.cpp
View file

@ -1,12 +1,14 @@
/*---------------------------------------------------------*\
| DeviceGuard.cpp |
| DeviceGuard.cpp |
| |
| An abstract interface for acquiring and releasing |
| a guard on a device, serving as a foundation for |
| implementing device-specific synchronization mechanisms. |
| An abstract interface for acquiring and releasing |
| a guard on a device, serving as a foundation for |
| 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"

12
interop/DeviceGuard.h
View file

@ -1,12 +1,14 @@
/*---------------------------------------------------------*\
| DeviceGuard.h |
| DeviceGuard.h |
| |
| An abstract interface for acquiring and releasing |
| a guard on a device, serving as a foundation for |
| implementing device-specific synchronization mechanisms. |
| An abstract interface for acquiring and releasing |
| a guard on a device, serving as a foundation for |
| 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

12
interop/DeviceGuardLock.cpp
View file

@ -1,12 +1,14 @@
/*---------------------------------------------------------*\
| DeviceGuardLock.cpp |
| DeviceGuardLock.cpp |
| |
| Represents a lock for a device guard, ensuring |
| exclusive access to a device when acquired |
| and releasing it when destroyed. |
| Represents a lock for a device guard, ensuring |
| exclusive access to a device when acquired and |
| 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"

12
interop/DeviceGuardLock.h
View file

@ -1,12 +1,14 @@
/*---------------------------------------------------------*\
| DeviceGuardLock.h |
| DeviceGuardLock.h |
| |
| Represents a lock for a device guard, ensuring |
| exclusive access to a device when acquired |
| and releasing it when destroyed. |
| Represents a lock for a device guard, ensuring |
| exclusive access to a device when acquired and |
| 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

12
interop/DeviceGuardManager.cpp
View file

@ -1,12 +1,14 @@
/*---------------------------------------------------------*\
| DeviceGuardManager.cpp |
| DeviceGuardManager.cpp |
| |
| Responsible for managing a DeviceGuard implementation, |
| allowing clients to wait for exclusive access to a |
| device using the DeviceGuardLock it provides. |
| Responsible for managing a DeviceGuard implementation, |
| allowing clients to wait for exclusive access to a |
| 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"

12
interop/DeviceGuardManager.h
View file

@ -1,12 +1,14 @@
/*---------------------------------------------------------*\
| DeviceGuardManager.h |
| DeviceGuardManager.h |
| |
| Responsible for managing a DeviceGuard implementation, |
| allowing clients to wait for exclusive access to a |
| device using the DeviceGuardLock it provides. |
| Responsible for managing a DeviceGuard implementation, |
| allowing clients to wait for exclusive access to a |
| 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

14
net_port/net_port.cpp
View file

@ -1,10 +1,14 @@
/*---------------------------------------------------------*\
| Cross Platform Network Library for Windows and Linux |
| This library provides access to TCP and UDP ports with |
| a common API for both Windows and Linux systems. It |
| features read and write |
| net_port.cpp |
| |
| Adam Honse (calcprogrammer1@gmail.com), 12/15/2016 |
| Cross Platform Network Library for Windows and Linux |
| This library provides access to TCP and UDP ports with |
| a common API for both Windows and Linux systems |
| |
| 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"

19
net_port/net_port.h
View file

@ -1,14 +1,17 @@
/*---------------------------------------------------------*\
| Cross Platform Network Library for Windows and Linux |
| This library provides access to TCP and UDP ports with |
| a common API for both Windows and Linux systems. It |
| features read and write |
| net_port.h |
| |
| Adam Honse (calcprogrammer1@gmail.com), 12/15/2016 |
| Cross Platform Network Library for Windows and Linux |
| This library provides access to TCP and UDP ports with |
| a common API for both Windows and Linux systems |
| |
| 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
#define NET_PORT_H
#pragma once
#include <vector>
@ -88,5 +91,3 @@ private:
sockaddr addrDest;
addrinfo* result_list;
};
#endif

5
scsiapi/scsiapi.h
View file

@ -3,7 +3,10 @@
| |
| 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

5
scsiapi/scsiapi_linux.c
View file

@ -4,7 +4,10 @@
| Cross-platform SCSI access library |
| 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

5
scsiapi/scsiapi_macos.c
View file

@ -4,7 +4,10 @@
| Cross-platform SCSI access library |
| 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

5
scsiapi/scsiapi_windows.c
View file

@ -4,7 +4,10 @@
| Cross-platform SCSI access library |
| 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

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 <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 <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 <initguid.h>

14
serial_port/serial_port.cpp
View file

@ -1,10 +1,14 @@
/*---------------------------------------------------------*\
| Cross Platform Serial COM Library for Windows and Linux |
| This library provides access to serial ports with a |
| common API for both Windows and Linux systems. It |
| features read and write as well as tx/rx buffer flush. |
| serial_port.cpp |
| |
| Adam Honse (calcprogrammer1@gmail.com), 1/21/2013 |
| Cross Platform Serial COM Library for Windows and Linux |
| This library provides access to serial ports with a |
| common API for both Windows and Linux systems |
| |
| 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"

14
serial_port/serial_port.h
View file

@ -1,10 +1,14 @@
/*---------------------------------------------------------*\
| Cross Platform Serial COM Library for Windows and Linux |
| This library provides access to serial ports with a |
| common API for both Windows and Linux systems. It |
| features read and write as well as tx/rx buffer flush. |
| serial_port.h |
| |
| Adam Honse (calcprogrammer1@gmail.com), 1/21/2013 |
| Cross Platform Serial COM Library for Windows and Linux |
| This library provides access to serial ports with a |
| common API for both Windows and Linux systems |
| |
| 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

18
super_io/super_io.cpp
View file

@ -1,10 +1,14 @@
/*-----------------------------------------*\
| super_io.cpp |
| |
| Functions for interfacing with Super-IO |
| |
| Adam Honse (CalcProgrammer1) 2/11/2020 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| super_io.cpp |
| |
| Functions for interfacing with Super-IO |
| |
| 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"
#ifdef WIN32

17
super_io/super_io.h
View file

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