From f38b7485f768b0a639fc617666484336db2638da Mon Sep 17 00:00:00 2001 From: Adam Honse Date: Fri, 3 May 2024 00:04:53 -0500 Subject: [PATCH] Start updating file header comments to standardized new format --- AutoStart/AutoStart-FreeBSD.cpp | 19 +++++----- AutoStart/AutoStart-FreeBSD.h | 9 +++++ AutoStart/AutoStart-Linux.cpp | 25 +++++++------ AutoStart/AutoStart-Linux.h | 9 +++++ AutoStart/AutoStart-MacOS.cpp | 28 ++++++++------- AutoStart/AutoStart-MacOS.h | 9 +++++ AutoStart/AutoStart-Windows.cpp | 36 ++++++++++--------- AutoStart/AutoStart-Windows.h | 9 +++++ AutoStart/AutoStart.cpp | 14 +++++--- AutoStart/AutoStart.h | 9 +++++ .../A4TechController/A4Tech_Detector.cpp | 22 ++++++------ .../BloodyB820RController.cpp | 32 +++++++++-------- .../BloodyB820RController.h | 22 ++++++------ .../RGBController_BloodyB820R.cpp | 18 +++++----- .../RGBController_BloodyB820R.h | 18 +++++----- .../BloodyMouseController.cpp | 18 +++++----- .../BloodyMouseController.h | 18 +++++----- .../RGBController_BloodyMouse.cpp | 18 +++++----- .../RGBController_BloodyMouse.h | 18 +++++----- .../AlienwareController.cpp | 17 +++++---- .../AlienwareController/AlienwareController.h | 18 +++++----- .../AlienwareControllerDetect.cpp | 9 +++++ .../RGBController_Alienware.cpp | 18 +++++----- .../RGBController_Alienware.h | 18 +++++----- .../AlienwareAW410KController.cpp | 21 +++++------ .../AlienwareAW410KController.h | 21 +++++------ .../RGBController_AlienwareAW410K.cpp | 21 +++++------ .../RGBController_AlienwareAW410K.h | 21 +++++------ .../AlienwareAW510KController.cpp | 18 +++++----- .../AlienwareAW510KController.h | 18 +++++----- .../RGBController_AlienwareAW510K.cpp | 18 +++++----- .../RGBController_AlienwareAW510K.h | 20 ++++++----- .../AlienwareKeyboardControllerDetect.cpp | 9 +++++ 33 files changed, 357 insertions(+), 241 deletions(-) diff --git a/AutoStart/AutoStart-FreeBSD.cpp b/AutoStart/AutoStart-FreeBSD.cpp index f335136e..1e198f7f 100644 --- a/AutoStart/AutoStart-FreeBSD.cpp +++ b/AutoStart/AutoStart-FreeBSD.cpp @@ -1,17 +1,20 @@ -#include "AutoStart-FreeBSD.h" -#include "LogManager.h" -#include "filesystem.h" +/*---------------------------------------------------------*\ +| AutoStart-FreeBSD.cpp | +| | +| Autostart implementation for FreeBSD | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include #include #include #include #include - -/*-----------------------------------------------------*\ -| FreeBSD AutoStart Implementation | -| Public Methods | -\*-----------------------------------------------------*/ +#include "AutoStart-FreeBSD.h" +#include "LogManager.h" +#include "filesystem.h" AutoStart::AutoStart(std::string name) { diff --git a/AutoStart/AutoStart-FreeBSD.h b/AutoStart/AutoStart-FreeBSD.h index 1a90ec31..96d1d0b2 100644 --- a/AutoStart/AutoStart-FreeBSD.h +++ b/AutoStart/AutoStart-FreeBSD.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| AutoStart-FreeBSD.h | +| | +| Autostart implementation for FreeBSD | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #pragma once #include diff --git a/AutoStart/AutoStart-Linux.cpp b/AutoStart/AutoStart-Linux.cpp index bbe754df..6df655d4 100644 --- a/AutoStart/AutoStart-Linux.cpp +++ b/AutoStart/AutoStart-Linux.cpp @@ -1,17 +1,20 @@ -#include "AutoStart-Linux.h" -#include "LogManager.h" -#include "filesystem.h" +/*---------------------------------------------------------*\ +| AutoStart-Linux.cpp | +| | +| Autostart implementation for Linux | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include #include #include #include #include - -/*-----------------------------------------------------*\ -| Linux AutoStart Implementation | -| Public Methods | -\*-----------------------------------------------------*/ +#include "AutoStart-Linux.h" +#include "LogManager.h" +#include "filesystem.h" AutoStart::AutoStart(std::string name) { @@ -122,7 +125,7 @@ std::string AutoStart::GetExePath() char exepath[ PATH_MAX ]; ssize_t count = readlink("/proc/self/exe", exepath, PATH_MAX); - + return(std::string(exepath, (count > 0) ? count : 0)); } @@ -159,7 +162,7 @@ std::string AutoStart::GenerateDesktopFile(AutoStartInfo autostart_info) } fileContents << std::endl; - + return(fileContents.str()); } @@ -198,7 +201,7 @@ void AutoStart::InitAutoStart(std::string name) std::error_code ec; bool success = true; - + if(!filesystem::exists(autostart_dir)) { success = filesystem::create_directories(autostart_dir, ec); diff --git a/AutoStart/AutoStart-Linux.h b/AutoStart/AutoStart-Linux.h index 3ea43ec8..b7f059c0 100644 --- a/AutoStart/AutoStart-Linux.h +++ b/AutoStart/AutoStart-Linux.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| AutoStart-Linux.h | +| | +| Autostart implementation for Linux | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #pragma once #include diff --git a/AutoStart/AutoStart-MacOS.cpp b/AutoStart/AutoStart-MacOS.cpp index 9060b597..20297140 100644 --- a/AutoStart/AutoStart-MacOS.cpp +++ b/AutoStart/AutoStart-MacOS.cpp @@ -1,18 +1,20 @@ -#include "AutoStart-MacOS.h" -#include "LogManager.h" -#include "filesystem.h" +/*---------------------------------------------------------*\ +| AutoStart-MacOS.cpp | +| | +| Autostart implementation for MacOS | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include #include #include #include - #include - -/*-----------------------------------------------------*\ -| MacOS AutoStart Implementation | -| Public Methods | -\*-----------------------------------------------------*/ +#include "AutoStart-MacOS.h" +#include "LogManager.h" +#include "filesystem.h" AutoStart::AutoStart(std::string name) { @@ -152,7 +154,7 @@ std::string AutoStart::GenerateLaunchAgentFile(AutoStartInfo autostart_info) fileContents << " ProgramArguments" << std::endl; fileContents << " " << std::endl; fileContents << " " << autostart_info.path << "" << std::endl; - + if(autostart_info.args != "") { std::istringstream arg_parser(autostart_info.args); @@ -163,12 +165,12 @@ std::string AutoStart::GenerateLaunchAgentFile(AutoStartInfo autostart_info) fileContents << " " << arg << "" << std::endl; } } - + fileContents << " " << std::endl; fileContents << " RunAtLoad" << std::endl; fileContents << "" << std::endl; fileContents << "" << std::endl; - + return(fileContents.str()); } @@ -193,7 +195,7 @@ void AutoStart::InitAutoStart(std::string name) std::error_code ec; bool success = true; - + if(!filesystem::exists(autostart_dir)) { success = filesystem::create_directories(autostart_dir, ec); diff --git a/AutoStart/AutoStart-MacOS.h b/AutoStart/AutoStart-MacOS.h index 1a90ec31..4d26ecae 100644 --- a/AutoStart/AutoStart-MacOS.h +++ b/AutoStart/AutoStart-MacOS.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| AutoStart-MacOS.h | +| | +| Autostart implementation for MacOS | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #pragma once #include diff --git a/AutoStart/AutoStart-Windows.cpp b/AutoStart/AutoStart-Windows.cpp index 8ca7cd8b..e7f62358 100644 --- a/AutoStart/AutoStart-Windows.cpp +++ b/AutoStart/AutoStart-Windows.cpp @@ -1,17 +1,19 @@ -#include "AutoStart-Windows.h" -#include "LogManager.h" -#include "filesystem.h" +/*---------------------------------------------------------*\ +| AutoStart-Windows.cpp | +| | +| Autostart implementation for Windows | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include #include - -#include "windows.h" #include - -/*-----------------------------------------------------*\ -| Windows AutoStart Implementation | -| Public Methods | -\*-----------------------------------------------------*/ +#include "AutoStart-Windows.h" +#include "LogManager.h" +#include "filesystem.h" +#include "windows.h" AutoStart::AutoStart(std::string name) { @@ -41,7 +43,7 @@ bool AutoStart::DisableAutoStart() else { success = filesystem::remove(autostart_file, autostart_file_remove_errcode); - + if(!success) { LOG_ERROR("An error occurred removing the auto start file."); @@ -97,11 +99,11 @@ bool AutoStart::EnableAutoStart(AutoStartInfo autostart_info) shellLink->SetArguments(argumentsw.c_str()); shellLink->SetDescription(descriptionw.c_str()); shellLink->SetIconLocation(iconw.c_str(), 0); - + IPersistFile* persistFile; - + result = shellLink->QueryInterface(IID_IPersistFile, (void**)&persistFile); - + if(SUCCEEDED(result)) { result = persistFile->Save(startupfilepathw.c_str(), TRUE); @@ -151,7 +153,7 @@ std::string AutoStart::GetExePath() char exepath[MAX_PATH] = ""; DWORD count = GetModuleFileNameA(NULL, exepath, MAX_PATH); - + return(std::string(exepath, (count > 0) ? count : 0)); } @@ -197,8 +199,8 @@ std::wstring AutoStart::utf8_decode(const std::string& str) int size_needed = MultiByteToWideChar(CP_UTF8, 0, &str[0], (int) str.size(), nullptr, 0); std::wstring wstrTo(size_needed, 0); - + MultiByteToWideChar(CP_UTF8, 0, &str[0], (int) str.size(), &wstrTo[0], size_needed); - + return(wstrTo); } diff --git a/AutoStart/AutoStart-Windows.h b/AutoStart/AutoStart-Windows.h index 017ec59a..96dced9f 100644 --- a/AutoStart/AutoStart-Windows.h +++ b/AutoStart/AutoStart-Windows.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| AutoStart-Windows.h | +| | +| Autostart implementation for Windows | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #pragma once #include diff --git a/AutoStart/AutoStart.cpp b/AutoStart/AutoStart.cpp index a483e29d..0b07cc56 100644 --- a/AutoStart/AutoStart.cpp +++ b/AutoStart/AutoStart.cpp @@ -1,9 +1,13 @@ -#include "AutoStart.h" +/*---------------------------------------------------------*\ +| AutoStart.cpp | +| | +| Autostart common implementation | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ -/*-----------------------------------------------------*\ -| Common AutoStart Implementation | -| Public Methods | -\*-----------------------------------------------------*/ +#include "AutoStart.h" std::string AutoStartInterface::GetAutoStartFile() { diff --git a/AutoStart/AutoStart.h b/AutoStart/AutoStart.h index 7b37e7c3..04eb432e 100644 --- a/AutoStart/AutoStart.h +++ b/AutoStart/AutoStart.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| AutoStart.h | +| | +| Autostart common implementation | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #pragma once #include diff --git a/Controllers/A4TechController/A4Tech_Detector.cpp b/Controllers/A4TechController/A4Tech_Detector.cpp index 8dfce919..84f33ca1 100644 --- a/Controllers/A4TechController/A4Tech_Detector.cpp +++ b/Controllers/A4TechController/A4Tech_Detector.cpp @@ -1,12 +1,14 @@ -/*-------------------------------------------------------------------*\ -| A4TechDetector.cpp | -| | -| Driver for A4Tech Devices Detector | -| | -| Chris M (Dr_No) 30 Jun 2022 | -| Mohammed Julfikar Ali Mahbub (o-julfikar) 01 Apr 2024 | -| | -\*-------------------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| A4TechDetector.cpp | +| | +| Detector for A4Tech Devices | +| | +| Chris M (Dr_No) 30 Jun 2022 | +| Mohammed Julfikar Ali Mahbub (o-julfikar) 01 Apr 2024 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ /*-----------------------------------------------------*\ | OpenRGB includes | @@ -57,4 +59,4 @@ void DetectBloodyB820R(hid_device_info* info, const std::string& name) REGISTER_HID_DETECTOR_IPU("Bloody W60 Pro", DetectA4TechMouseControllers, A4_TECH_VID, BLOODY_W60_PRO_PID, 2, 0xFF33, 0x0529); REGISTER_HID_DETECTOR_IPU("Bloody W90 Max", DetectA4TechMouseControllers, A4_TECH_VID, BLOODY_W90_MAX_PID, 2, 0xFF33, 0x053D); REGISTER_HID_DETECTOR_IPU("Bloody MP 50RS", DetectA4TechMouseControllers, A4_TECH_VID, BLOODY_MP_50RS_PID, 2, 0xFFF2, 0x6009); -REGISTER_HID_DETECTOR_IPU("A4Tech Bloody B820R", DetectBloodyB820R, A4_TECH_VID, BLOODY_B820R_PID, 2, 0xFF52, 0x0210); \ No newline at end of file +REGISTER_HID_DETECTOR_IPU("A4Tech Bloody B820R", DetectBloodyB820R, A4_TECH_VID, BLOODY_B820R_PID, 2, 0xFF52, 0x0210); diff --git a/Controllers/A4TechController/BloodyB820RController/BloodyB820RController.cpp b/Controllers/A4TechController/BloodyB820RController/BloodyB820RController.cpp index 5226c121..029ce25e 100644 --- a/Controllers/A4TechController/BloodyB820RController/BloodyB820RController.cpp +++ b/Controllers/A4TechController/BloodyB820RController/BloodyB820RController.cpp @@ -1,21 +1,23 @@ -/*-------------------------------------------------------------------*\ -| BloodyB820RController.cpp | -| | -| Driver for A4Tech Bloody B820R Keyboard Controller | -| | -| Mohammed Julfikar Ali Mahbub (o-julfikar) 01 Apr 2024 | -| | -\*-------------------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| BloodyB820RController.cpp | +| | +| Driver for A4Tech Bloody B820R Keyboard | +| | +| Mohammed Julfikar Ali Mahbub (o-julfikar) 01 Apr 2024 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include "BloodyB820RController.h" -/*--------------------------------------------------------------------------------------*\ - * The controller for this device should pass a packet of 64 bytes where the subsequent * - * two packets are for RED, GREEN, and BLUE respectively. The first 6 bytes are control * - * or information bytes and colors bytes starts from index 6. Moreover, the first pack- * - * et of each RGB contains color for 58 keys and the rest (104 - 58 == 46) are send on * - * the second packet. * -\*--------------------------------------------------------------------------------------*/ +/*-------------------------------------------------------------------------------------*\ +| The controller for this device should pass a packet of 64 bytes where the subsequent | +| two packets are for RED, GREEN, and BLUE respectively. The first 6 bytes are control | +| or information bytes and colors bytes starts from index 6. Moreover, the first pack- | +| et of each RGB contains color for 58 keys and the rest (104 - 58 == 46) are send on | +| the second packet. | +\*-------------------------------------------------------------------------------------*/ BloodyB820RController::BloodyB820RController(hid_device* dev_handle, const char* path) { diff --git a/Controllers/A4TechController/BloodyB820RController/BloodyB820RController.h b/Controllers/A4TechController/BloodyB820RController/BloodyB820RController.h index bbd450bb..1b784785 100644 --- a/Controllers/A4TechController/BloodyB820RController/BloodyB820RController.h +++ b/Controllers/A4TechController/BloodyB820RController/BloodyB820RController.h @@ -1,11 +1,13 @@ -/*-------------------------------------------------------------------*\ -| BloodyB820RController.h | -| | -| Driver for A4Tech Bloody B820R Keyboard Controller | -| | -| Mohammed Julfikar Ali Mahbub (o-julfikar) 01 Apr 2024 | -| | -\*-------------------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| BloodyB820RController.h | +| | +| Driver for A4Tech Bloody B820R Keyboard | +| | +| Mohammed Julfikar Ali Mahbub (o-julfikar) 01 Apr 2024 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once @@ -25,9 +27,9 @@ #define BLOODY_B820R_RELEASE_CONTROL 0x00 /*---------------------------------------------------------*\ -| Bloody B820R product ID | +| Bloody B820R product ID | \*---------------------------------------------------------*/ -#define BLOODY_B820R_PID 0xFA10 +#define BLOODY_B820R_PID 0xFA10 enum { diff --git a/Controllers/A4TechController/BloodyB820RController/RGBController_BloodyB820R.cpp b/Controllers/A4TechController/BloodyB820RController/RGBController_BloodyB820R.cpp index 3fbf02e2..75769387 100644 --- a/Controllers/A4TechController/BloodyB820RController/RGBController_BloodyB820R.cpp +++ b/Controllers/A4TechController/BloodyB820RController/RGBController_BloodyB820R.cpp @@ -1,11 +1,13 @@ -/*-------------------------------------------------------------------*\ -| RGBController_BloodyB820R.cpp | -| | -| Driver for A4Tech Bloody B820R Keyboard Controller | -| | -| Mohammed Julfikar Ali Mahbub (o-julfikar) 01 Apr 2024 | -| | -\*-------------------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_BloodyB820R.cpp | +| | +| RGBController for A4Tech Bloody B820R Keyboard | +| | +| Mohammed Julfikar Ali Mahbub (o-julfikar) 01 Apr 2024 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include "RGBControllerKeyNames.h" #include "RGBController_BloodyB820R.h" diff --git a/Controllers/A4TechController/BloodyB820RController/RGBController_BloodyB820R.h b/Controllers/A4TechController/BloodyB820RController/RGBController_BloodyB820R.h index 7ea2995f..a9659e60 100644 --- a/Controllers/A4TechController/BloodyB820RController/RGBController_BloodyB820R.h +++ b/Controllers/A4TechController/BloodyB820RController/RGBController_BloodyB820R.h @@ -1,11 +1,13 @@ -/*-------------------------------------------------------------------*\ -| RGBController_BloodyB820R.h | -| | -| Driver for A4Tech Bloody B820R Keyboard Controller | -| | -| Mohammed Julfikar Ali Mahbub (o-julfikar) 01 Apr 2024 | -| | -\*-------------------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_BloodyB820R.h | +| | +| RGBController for A4Tech Bloody B820R Keyboard | +| | +| Mohammed Julfikar Ali Mahbub (o-julfikar) 01 Apr 2024 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/Controllers/A4TechController/BloodyMouseController/BloodyMouseController.cpp b/Controllers/A4TechController/BloodyMouseController/BloodyMouseController.cpp index e0850d64..b7e57c4f 100644 --- a/Controllers/A4TechController/BloodyMouseController/BloodyMouseController.cpp +++ b/Controllers/A4TechController/BloodyMouseController/BloodyMouseController.cpp @@ -1,11 +1,13 @@ -/*---------------------------------------------------------------------*\ -| BloodyMouseController.cpp | -| | -| Driver for BloodyMouse USB Controller | -| | -| Chris M (Dr_No) 30 Jun 2022 | -| | -\*---------------------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| BloodyMouseController.cpp | +| | +| Driver for A4Tech Bloody Mouse | +| | +| Chris M (Dr_No) 30 Jun 2022 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include "BloodyMouseController.h" #include "LogManager.h" diff --git a/Controllers/A4TechController/BloodyMouseController/BloodyMouseController.h b/Controllers/A4TechController/BloodyMouseController/BloodyMouseController.h index 23f088e5..2538e90c 100644 --- a/Controllers/A4TechController/BloodyMouseController/BloodyMouseController.h +++ b/Controllers/A4TechController/BloodyMouseController/BloodyMouseController.h @@ -1,11 +1,13 @@ -/*---------------------------------------------------------------------*\ -| BloodyMouseController.h | -| | -| Driver for BloodyMouse USB Controller | -| | -| Chris M (Dr_No) 30 Jun 2022 | -| | -\*---------------------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| BloodyMouseController.h | +| | +| Driver for A4Tech Bloody Mouse | +| | +| Chris M (Dr_No) 30 Jun 2022 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/Controllers/A4TechController/BloodyMouseController/RGBController_BloodyMouse.cpp b/Controllers/A4TechController/BloodyMouseController/RGBController_BloodyMouse.cpp index 20122dff..324099cc 100644 --- a/Controllers/A4TechController/BloodyMouseController/RGBController_BloodyMouse.cpp +++ b/Controllers/A4TechController/BloodyMouseController/RGBController_BloodyMouse.cpp @@ -1,11 +1,13 @@ -/*---------------------------------------------------------------------*\ -| RGBController_BloodyMouse.cpp | -| | -| Driver for BloodyMouse USB Controller | -| | -| Chris M (Dr_No) 30 Jun 2022 | -| | -\*---------------------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_BloodyMouse.cpp | +| | +| RGBController for A4Tech Bloody Mouse | +| | +| Chris M (Dr_No) 30 Jun 2022 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include "RGBController_BloodyMouse.h" diff --git a/Controllers/A4TechController/BloodyMouseController/RGBController_BloodyMouse.h b/Controllers/A4TechController/BloodyMouseController/RGBController_BloodyMouse.h index 14b33ae4..ec7dfa96 100644 --- a/Controllers/A4TechController/BloodyMouseController/RGBController_BloodyMouse.h +++ b/Controllers/A4TechController/BloodyMouseController/RGBController_BloodyMouse.h @@ -1,11 +1,13 @@ -/*---------------------------------------------------------------------*\ -| RGBController_BloodyMouse.h | -| | -| Driver for BloodyMouse USB Controller | -| | -| Chris M (Dr_No) 30 Jun 2022 | -| | -\*---------------------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_BloodyMouse.h | +| | +| RGBController for A4Tech Bloody Mouse | +| | +| Chris M (Dr_No) 30 Jun 2022 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/Controllers/AlienwareController/AlienwareController.cpp b/Controllers/AlienwareController/AlienwareController.cpp index e6c51374..08d89639 100644 --- a/Controllers/AlienwareController/AlienwareController.cpp +++ b/Controllers/AlienwareController/AlienwareController.cpp @@ -1,10 +1,13 @@ -/*-----------------------------------------*\ -| AlienwareController.cpp | -| | -| Driver for Alienware lighting controller | -| | -| Gabriel Marcano (gemarcano) 4/21/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| AlienwareController.cpp | +| | +| Driver for Dell Alienware RGB USB controller | +| | +| Gabriel Marcano (gemarcano) 21 Apr 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include #include diff --git a/Controllers/AlienwareController/AlienwareController.h b/Controllers/AlienwareController/AlienwareController.h index b5cabd37..49a33959 100644 --- a/Controllers/AlienwareController/AlienwareController.h +++ b/Controllers/AlienwareController/AlienwareController.h @@ -1,11 +1,13 @@ -/*-----------------------------------------*\ -| AlienwareController.h | -| | -| Driver for Dell Alienware RGB USB | -| controller | -| | -| Gabriel Marcano (gemarcano) 4/19/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| AlienwareController.h | +| | +| Driver for Dell Alienware RGB USB controller | +| | +| Gabriel Marcano (gemarcano) 19 Apr 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/Controllers/AlienwareController/AlienwareControllerDetect.cpp b/Controllers/AlienwareController/AlienwareControllerDetect.cpp index c97ce62d..09edb5d6 100644 --- a/Controllers/AlienwareController/AlienwareControllerDetect.cpp +++ b/Controllers/AlienwareController/AlienwareControllerDetect.cpp @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| AlienwareControllerDetect.cpp | +| | +| Detector for Dell Alienware RGB USB controller | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #include "Detector.h" #include "AlienwareController.h" #include "RGBController.h" diff --git a/Controllers/AlienwareController/RGBController_Alienware.cpp b/Controllers/AlienwareController/RGBController_Alienware.cpp index becc9fca..b02806b4 100644 --- a/Controllers/AlienwareController/RGBController_Alienware.cpp +++ b/Controllers/AlienwareController/RGBController_Alienware.cpp @@ -1,11 +1,13 @@ -/*-----------------------------------------*\ -| RGBController_Alienware.cpp | -| | -| Generic RGB Interface for OpenRGB | -| Alienware USB Driver | -| | -| Gabriel Marcano (gemarcano) 4/19/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_Alienware.cpp | +| | +| RGBController for Dell Alienware RGB USB controller | +| | +| Gabriel Marcano (gemarcano) 19 Apr 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include #include diff --git a/Controllers/AlienwareController/RGBController_Alienware.h b/Controllers/AlienwareController/RGBController_Alienware.h index 59caa7a5..8edfbe93 100644 --- a/Controllers/AlienwareController/RGBController_Alienware.h +++ b/Controllers/AlienwareController/RGBController_Alienware.h @@ -1,11 +1,13 @@ -/*-----------------------------------------*\ -| RGBController_Alienware.h | -| | -| Generic RGB Interface for OpenRGB | -| Alienware RGB USB Driver | -| | -| Gabriel Marcano (gemarcano) 4/19/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_Alienware.h | +| | +| RGBController for Dell Alienware RGB USB controller | +| | +| Gabriel Marcano (gemarcano) 19 Apr 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/Controllers/AlienwareKeyboardController/AlienwareAW410KController/AlienwareAW410KController.cpp b/Controllers/AlienwareKeyboardController/AlienwareAW410KController/AlienwareAW410KController.cpp index d7acb74e..1f01a6d8 100644 --- a/Controllers/AlienwareKeyboardController/AlienwareAW410KController/AlienwareAW410KController.cpp +++ b/Controllers/AlienwareKeyboardController/AlienwareAW410KController/AlienwareAW410KController.cpp @@ -1,13 +1,14 @@ -/*------------------------------------------------------*\ -| AlienwareAW410KController.cpp | -| | -| Driver for Alienware AW410K | -| keyboard light controller | -| | -| based on AW510K controller by Mohamad Sallal - msallal| -| | -| Dominik Mikolajczyk - dmiko 23/10/2023 | -\*------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| AlienwareAW410KController.cpp | +| | +| Driver for Alienware AW410K keyboard | +| | +| based on AW510K controller by Mohamad Sallal (msallal) | +| Dominik Mikolajczyk (dmiko) 23 Oct 2023 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include #include "AlienwareAW410KController.h" diff --git a/Controllers/AlienwareKeyboardController/AlienwareAW410KController/AlienwareAW410KController.h b/Controllers/AlienwareKeyboardController/AlienwareAW410KController/AlienwareAW410KController.h index 18a246e8..9469cb09 100644 --- a/Controllers/AlienwareKeyboardController/AlienwareAW410KController/AlienwareAW410KController.h +++ b/Controllers/AlienwareKeyboardController/AlienwareAW410KController/AlienwareAW410KController.h @@ -1,13 +1,14 @@ -/*------------------------------------------------------*\ -| AlienwareAW410KController.h | -| | -| Definitions and types for alienware | -| AW410K Keyboard | -| | -| based on AW510K controller by Mohamad Sallal - msallal| -| | -| Dominik Mikolajczyk - dmiko 23/10/2023 | -\*------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| AlienwareAW410KController.h | +| | +| Driver for Alienware AW410K keyboard | +| | +| based on AW510K controller by Mohamad Sallal (msallal) | +| Dominik Mikolajczyk (dmiko) 23 Oct 2023 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/Controllers/AlienwareKeyboardController/AlienwareAW410KController/RGBController_AlienwareAW410K.cpp b/Controllers/AlienwareKeyboardController/AlienwareAW410KController/RGBController_AlienwareAW410K.cpp index 5e58c730..97dc71e1 100644 --- a/Controllers/AlienwareKeyboardController/AlienwareAW410KController/RGBController_AlienwareAW410K.cpp +++ b/Controllers/AlienwareKeyboardController/AlienwareAW410KController/RGBController_AlienwareAW410K.cpp @@ -1,13 +1,14 @@ -/*------------------------------------------------------*\ -| RGBController_AlienwareAW410K.cpp | -| | -| Generic RGB Interface for alienware | -| AW410K Keyboard | -| | -| based on AW510K controller by Mohamad Sallal - msallal| -| | -| Dominik Mikolajczyk - dmiko 23/10/2023 | -\*------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_AlienwareAW410K.cpp | +| | +| RGBController for Alienware AW410K keyboard | +| | +| based on AW510K controller by Mohamad Sallal (msallal) | +| Dominik Mikolajczyk (dmiko) 23 Oct 2023 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include #include "RGBControllerKeyNames.h" diff --git a/Controllers/AlienwareKeyboardController/AlienwareAW410KController/RGBController_AlienwareAW410K.h b/Controllers/AlienwareKeyboardController/AlienwareAW410KController/RGBController_AlienwareAW410K.h index 8a44ca81..312383ce 100644 --- a/Controllers/AlienwareKeyboardController/AlienwareAW410KController/RGBController_AlienwareAW410K.h +++ b/Controllers/AlienwareKeyboardController/AlienwareAW410KController/RGBController_AlienwareAW410K.h @@ -1,13 +1,14 @@ -/*------------------------------------------------------*\ -| RGBController_AlienwareAW410K.h | -| | -| Generic RGB Interface for Alienware | -| AW410K keyboard | -| | -| based on AW510K controller by Mohamad Sallal - msallal| -| | -| Dominik Mikolajczyk - dmiko 23/10/2023 | -\*------------------------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_AlienwareAW410K.h | +| | +| RGBController for Alienware AW410K keyboard | +| | +| based on AW510K controller by Mohamad Sallal (msallal) | +| Dominik Mikolajczyk (dmiko) 23 Oct 2023 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/Controllers/AlienwareKeyboardController/AlienwareAW510KController/AlienwareAW510KController.cpp b/Controllers/AlienwareKeyboardController/AlienwareAW510KController/AlienwareAW510KController.cpp index 88a27c52..eee3f103 100644 --- a/Controllers/AlienwareKeyboardController/AlienwareAW510KController/AlienwareAW510KController.cpp +++ b/Controllers/AlienwareKeyboardController/AlienwareAW510KController/AlienwareAW510KController.cpp @@ -1,11 +1,13 @@ -/*-----------------------------------------*\ -| AlienwareAW510KController.cpp | -| | -| Driver for Alienware AW510K | -| keyboard light controller | -| | -| Mohamad Sallal - msallal 05/22/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| AlienwareAW510KController.cpp | +| | +| Driver for Alienware AW510K keyboard | +| | +| Mohamad Sallal (msallal) 22 May 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include #include "AlienwareAW510KController.h" diff --git a/Controllers/AlienwareKeyboardController/AlienwareAW510KController/AlienwareAW510KController.h b/Controllers/AlienwareKeyboardController/AlienwareAW510KController/AlienwareAW510KController.h index 28d41c1b..1eb13e61 100644 --- a/Controllers/AlienwareKeyboardController/AlienwareAW510KController/AlienwareAW510KController.h +++ b/Controllers/AlienwareKeyboardController/AlienwareAW510KController/AlienwareAW510KController.h @@ -1,11 +1,13 @@ -/*-----------------------------------------*\ -| AlienwareAW510KController.h | -| | -| Definitions and types for alienware | -| AW510K Keyboard | -| | -| Mohamad Sallal - msallal 05/22/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| AlienwareAW510KController.h | +| | +| Driver for Alienware AW510K keyboard | +| | +| Mohamad Sallal (msallal) 22 May 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/Controllers/AlienwareKeyboardController/AlienwareAW510KController/RGBController_AlienwareAW510K.cpp b/Controllers/AlienwareKeyboardController/AlienwareAW510KController/RGBController_AlienwareAW510K.cpp index 8f985fa1..3f3f97cc 100644 --- a/Controllers/AlienwareKeyboardController/AlienwareAW510KController/RGBController_AlienwareAW510K.cpp +++ b/Controllers/AlienwareKeyboardController/AlienwareAW510KController/RGBController_AlienwareAW510K.cpp @@ -1,11 +1,13 @@ -/*-----------------------------------------*\ -| RGBController_AlienwareAW510K.cpp | -| | -| Generic RGB Interface for alienware | -| AW510K Keyboard | -| | -| Mohamad Sallal - msallal 05/22/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_AlienwareAW510K.cpp | +| | +| RGBController for Alienware AW510K keyboard | +| | +| Mohamad Sallal (msallal) 22 May 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include #include "RGBControllerKeyNames.h" diff --git a/Controllers/AlienwareKeyboardController/AlienwareAW510KController/RGBController_AlienwareAW510K.h b/Controllers/AlienwareKeyboardController/AlienwareAW510KController/RGBController_AlienwareAW510K.h index 00c6f3ff..6f9dea3f 100644 --- a/Controllers/AlienwareKeyboardController/AlienwareAW510KController/RGBController_AlienwareAW510K.h +++ b/Controllers/AlienwareKeyboardController/AlienwareAW510KController/RGBController_AlienwareAW510K.h @@ -1,11 +1,13 @@ -/*-----------------------------------------*\ -| RGBController_AlienwareAW510K.h | -| | -| Generic RGB Interface for Alienware | -| AW510K keyboard | -| | -| Mohamad Sallal - msallal 05/22/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_AlienwareAW510K.h | +| | +| RGBController for Alienware AW510K keyboard | +| | +| Mohamad Sallal (msallal) 22 May 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once @@ -21,7 +23,7 @@ public: void SetupZones(); void ResizeZone(int zone, int new_size); - + void DeviceUpdateLEDs(); void UpdateZoneLEDs(int zone); void UpdateSingleLED(int led); diff --git a/Controllers/AlienwareKeyboardController/AlienwareKeyboardControllerDetect.cpp b/Controllers/AlienwareKeyboardController/AlienwareKeyboardControllerDetect.cpp index 55b2e35b..d094225f 100644 --- a/Controllers/AlienwareKeyboardController/AlienwareKeyboardControllerDetect.cpp +++ b/Controllers/AlienwareKeyboardController/AlienwareKeyboardControllerDetect.cpp @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| AlienwareKeyboardControllerDetect.cpp | +| | +| Detector for Alienware Keyboard | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #include #include "Detector.h" #include "AlienwareAW510KController.h"