diff --git a/Colors.h b/Colors.h index 345df3ad..7c890991 100644 --- a/Colors.h +++ b/Colors.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| Colors.h | +| | +| List of named color constants | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #ifndef COLORS_H #define COLORS_H diff --git a/Detector.h b/Detector.h index 6c6cc391..7e1226d1 100644 --- a/Detector.h +++ b/Detector.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| Detector.h | +| | +| Macros for registering detectors | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #pragma once #include "DeviceDetector.h" diff --git a/DeviceDetector.h b/DeviceDetector.h index 8bf3520a..56886f5b 100644 --- a/DeviceDetector.h +++ b/DeviceDetector.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| DeviceDetector.h | +| | +| Device detector functionality | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #pragma once #include diff --git a/LogManager.cpp b/LogManager.cpp index 43a1596d..979948cf 100644 --- a/LogManager.cpp +++ b/LogManager.cpp @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| LogManager.cpp | +| | +| Manages log file and output to the console | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #include "LogManager.h" #include diff --git a/LogManager.h b/LogManager.h index cb7b384b..ba3f1183 100644 --- a/LogManager.h +++ b/LogManager.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| LogManager.h | +| | +| Manages log file and output to the console | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #ifndef LOGMANAGER_H #define LOGMANAGER_H diff --git a/NetworkClient.cpp b/NetworkClient.cpp index 92a6cb1d..c32d011b 100644 --- a/NetworkClient.cpp +++ b/NetworkClient.cpp @@ -1,14 +1,17 @@ -/*-----------------------------------------*\ -| NetworkClient.cpp | -| | -| Client code for OpenRGB SDK | -| | -| Adam Honse (CalcProgrammer1) 5/9/2020 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| NetworkClient.cpp | +| | +| OpenRGB SDK network client | +| | +| Adam Honse (CalcProgrammer1) 09 May 2020 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ +#include #include "NetworkClient.h" #include "RGBController_Network.h" -#include #ifdef _WIN32 #include diff --git a/NetworkClient.h b/NetworkClient.h index 8d29287c..aebc1b45 100644 --- a/NetworkClient.h +++ b/NetworkClient.h @@ -1,19 +1,21 @@ -/*-----------------------------------------*\ -| NetworkClient.h | -| | -| Client header for OpenRGB SDK | -| | -| Adam Honse (CalcProgrammer1) 5/9/2020 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| NetworkClient.h | +| | +| OpenRGB SDK network client | +| | +| Adam Honse (CalcProgrammer1) 09 May 2020 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ -#include "RGBController.h" -#include "NetworkProtocol.h" -#include "net_port.h" +#pragma once #include #include - -#pragma once +#include "RGBController.h" +#include "NetworkProtocol.h" +#include "net_port.h" typedef void (*NetClientCallback)(void *); diff --git a/NetworkProtocol.cpp b/NetworkProtocol.cpp index 4fba58b8..b296347c 100644 --- a/NetworkProtocol.cpp +++ b/NetworkProtocol.cpp @@ -1,5 +1,16 @@ -#include "NetworkProtocol.h" +/*---------------------------------------------------------*\ +| NetworkProtocol.cpp | +| | +| OpenRGB SDK network protocol | +| | +| Adam Honse (CalcProgrammer1) 09 May 2020 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #include +#include "NetworkProtocol.h" /*-----------------------------------------------------*\ | OpenRGB SDK Magic Value "ORGB" | diff --git a/NetworkProtocol.h b/NetworkProtocol.h index 51ccdff7..528b538e 100644 --- a/NetworkProtocol.h +++ b/NetworkProtocol.h @@ -1,10 +1,13 @@ -/*-----------------------------------------*\ -| NetworkProtocol.h | -| | -| Protocol header for OpenRGB SDK | -| | -| Adam Honse (CalcProgrammer1) 5/9/2020 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| NetworkProtocol.h | +| | +| OpenRGB SDK network protocol | +| | +| Adam Honse (CalcProgrammer1) 09 May 2020 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/NetworkServer.cpp b/NetworkServer.cpp index ff6b76d5..3ac763b5 100644 --- a/NetworkServer.cpp +++ b/NetworkServer.cpp @@ -1,14 +1,17 @@ -/*-----------------------------------------*\ -| NetworkServer.cpp | -| | -| Server code for OpenRGB SDK | -| | -| Adam Honse (CalcProgrammer1) 5/9/2020 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| NetworkServer.cpp | +| | +| OpenRGB SDK network server | +| | +| Adam Honse (CalcProgrammer1) 09 May 2020 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ +#include #include "NetworkServer.h" #include "LogManager.h" -#include #ifndef WIN32 #include diff --git a/NetworkServer.h b/NetworkServer.h index c7766599..7db5bc12 100644 --- a/NetworkServer.h +++ b/NetworkServer.h @@ -1,21 +1,23 @@ -/*-----------------------------------------*\ -| NetworkServer.h | -| | -| Server header for OpenRGB SDK | -| | -| Adam Honse (CalcProgrammer1) 5/9/2020 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| NetworkServer.h | +| | +| OpenRGB SDK network server | +| | +| Adam Honse (CalcProgrammer1) 09 May 2020 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ -#include "RGBController.h" -#include "NetworkProtocol.h" -#include "net_port.h" -#include "ProfileManager.h" +#pragma once #include #include #include - -#pragma once +#include "RGBController.h" +#include "NetworkProtocol.h" +#include "net_port.h" +#include "ProfileManager.h" #define MAXSOCK 32 #define TCP_TIMEOUT_SECONDS 5 diff --git a/OpenRGBPluginInterface.h b/OpenRGBPluginInterface.h index 0b8dab0a..0799fe5a 100644 --- a/OpenRGBPluginInterface.h +++ b/OpenRGBPluginInterface.h @@ -1,19 +1,21 @@ -/*-----------------------------------------*\ -| OpenRGBPluginInterface.h | -| | -| OpenRGB Plugin Interface Class | -| | -| herosilas12 (CoffeeIsLife) 12/11/2020 | -| Adam Honse (CalcProgrammer1) 1/5/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| OpenRGBPluginInterface.h | +| | +| OpenRGB SDK network protocol | +| | +| herosilas12 (CoffeeIsLife) 11 Dec 2020 | +| Adam Honse (CalcProgrammer1) 05 Jan 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once -#include "ResourceManager.h" - #include #include #include +#include "ResourceManager.h" #define OpenRGBPluginInterface_IID "com.OpenRGBPluginInterface" diff --git a/PluginManager.cpp b/PluginManager.cpp index ed2ea5e4..098e9d98 100644 --- a/PluginManager.cpp +++ b/PluginManager.cpp @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| PluginManager.cpp | +| | +| OpenRGB plugin manager | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #include "LogManager.h" #include "filesystem.h" #include "PluginManager.h" diff --git a/PluginManager.h b/PluginManager.h index 5f637b61..7e90b79d 100644 --- a/PluginManager.h +++ b/PluginManager.h @@ -1,14 +1,21 @@ +/*---------------------------------------------------------*\ +| PluginManager.h | +| | +| OpenRGB plugin manager | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #pragma once -#include "OpenRGBPluginInterface.h" - +#include +#include #include #include #include #include - -#include -#include +#include "OpenRGBPluginInterface.h" typedef struct { diff --git a/ProfileManager.cpp b/ProfileManager.cpp index 14aecb95..e8dd8954 100644 --- a/ProfileManager.cpp +++ b/ProfileManager.cpp @@ -1,12 +1,21 @@ +/*---------------------------------------------------------*\ +| ProfileManager.cpp | +| | +| OpenRGB profile manager | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + +#include +#include +#include #include "ProfileManager.h" #include "ResourceManager.h" #include "RGBController_Dummy.h" #include "LogManager.h" #include "NetworkProtocol.h" #include "filesystem.h" -#include -#include -#include #include "StringUtils.h" #define OPENRGB_PROFILE_HEADER "OPENRGB_PROFILE" diff --git a/ProfileManager.h b/ProfileManager.h index 793d1d29..082d0566 100644 --- a/ProfileManager.h +++ b/ProfileManager.h @@ -1,7 +1,15 @@ +/*---------------------------------------------------------*\ +| ProfileManager.h | +| | +| OpenRGB profile manager | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #pragma once #include "RGBController.h" - #include "filesystem.h" class ProfileManagerInterface diff --git a/ResourceManager.cpp b/ResourceManager.cpp index 5c041698..1405833d 100644 --- a/ResourceManager.cpp +++ b/ResourceManager.cpp @@ -1,22 +1,15 @@ -/*-----------------------------------------*\ -| ResourceManager.cpp | -| | -| OpenRGB Resource Manager controls access | -| to application components including | -| RGBControllers, I2C interfaces, and | -| network SDK components | -| | -| Adam Honse (CalcProgrammer1) 9/27/2020 | -\*-----------------------------------------*/ - -#include "ResourceManager.h" -#include "ProfileManager.h" -#include "LogManager.h" -#include "SettingsManager.h" -#include "NetworkClient.h" -#include "NetworkServer.h" -#include "filesystem.h" -#include "StringUtils.h" +/*---------------------------------------------------------*\ +| ResourceManager.cpp | +| | +| OpenRGB Resource Manager controls access to application | +| components including RGBControllers, I2C interfaces, | +| and network SDK components | +| | +| Adam Honse (CalcProgrammer1) 27 Sep 2020 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #ifdef _WIN32 #include @@ -26,6 +19,14 @@ #include #include #include +#include "ResourceManager.h" +#include "ProfileManager.h" +#include "LogManager.h" +#include "SettingsManager.h" +#include "NetworkClient.h" +#include "NetworkServer.h" +#include "filesystem.h" +#include "StringUtils.h" const hidapi_wrapper default_wrapper = { diff --git a/ResourceManager.h b/ResourceManager.h index 4be258ba..581b5a36 100644 --- a/ResourceManager.h +++ b/ResourceManager.h @@ -1,13 +1,15 @@ -/*-----------------------------------------*\ -| ResourceManager.h | -| | -| OpenRGB Resource Manager controls access | -| to application components including | -| RGBControllers, I2C interfaces, and | -| network SDK components | -| | -| Adam Honse (CalcProgrammer1) 9/27/2020 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| ResourceManager.h | +| | +| OpenRGB Resource Manager controls access to application | +| components including RGBControllers, I2C interfaces, | +| and network SDK components | +| | +| Adam Honse (CalcProgrammer1) 27 Sep 2020 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once @@ -16,7 +18,6 @@ #include #include #include - #include "hidapi_wrapper.h" #include "i2c_smbus.h" #include "filesystem.h" diff --git a/SettingsManager.cpp b/SettingsManager.cpp index 3e9864de..fde61b13 100644 --- a/SettingsManager.cpp +++ b/SettingsManager.cpp @@ -1,19 +1,20 @@ -/*-----------------------------------------*\ -| SettingsManager.cpp | -| | -| OpenRGB Settings Manager maintains a list| -| of application settings in JSON format. | -| Other components may register settings | -| with this class and store/load values. | -| | -| Adam Honse (CalcProgrammer1) 11/4/2020 | -\*-----------------------------------------*/ - -#include "SettingsManager.h" -#include "LogManager.h" +/*---------------------------------------------------------*\ +| SettingsManager.cpp | +| | +| OpenRGB Settings Manager maintains a list of application| +| settings in JSON format. Other components may register | +| settings with this class and store/load values. | +| | +| Adam Honse (CalcProgrammer1) 04 Nov 2020 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include #include +#include "SettingsManager.h" +#include "LogManager.h" SettingsManager::SettingsManager() { diff --git a/SettingsManager.h b/SettingsManager.h index dc526c58..fd2edff6 100644 --- a/SettingsManager.h +++ b/SettingsManager.h @@ -1,13 +1,15 @@ -/*-----------------------------------------*\ -| SettingsManager.h | -| | -| OpenRGB Settings Manager maintains a list| -| of application settings in JSON format. | -| Other components may register settings | -| with this class and store/load values. | -| | -| Adam Honse (CalcProgrammer1) 11/4/2020 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| SettingsManager.h | +| | +| OpenRGB Settings Manager maintains a list of application| +| settings in JSON format. Other components may register | +| settings with this class and store/load values. | +| | +| Adam Honse (CalcProgrammer1) 04 Nov 2020 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/StringUtils.cpp b/StringUtils.cpp index 3957abbc..71e84c34 100644 --- a/StringUtils.cpp +++ b/StringUtils.cpp @@ -1,5 +1,14 @@ -#include "StringUtils.h" +/*---------------------------------------------------------*\ +| StringUtils.cpp | +| | +| String utility functions | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #include +#include "StringUtils.h" const char* StringUtils::wchar_to_char(const wchar_t* pwchar) { diff --git a/StringUtils.h b/StringUtils.h index ea8ea613..64d8a470 100644 --- a/StringUtils.h +++ b/StringUtils.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| StringUtils.h | +| | +| String utility functions | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #ifndef STRING_UTILS_H #define STRING_UTILS_H diff --git a/filesystem.h b/filesystem.h index cb296956..b56f28c8 100644 --- a/filesystem.h +++ b/filesystem.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| filesystem.h | +| | +| Selects between std and experimental filesystem library | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #ifndef FILESYSTEM_H #define FILESYSTEM_H diff --git a/main.cpp b/main.cpp index 6a5f44ec..11ecad68 100644 --- a/main.cpp +++ b/main.cpp @@ -1,11 +1,16 @@ -/******************************************************************************************\ -* * -* main.cpp * -* * -* Main function for OpenAuraSDK GUI project * -* * -\******************************************************************************************/ +/*---------------------------------------------------------*\ +| main.cpp | +| | +| Entry point for the OpenRGB application | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ +#include +#include +#include +#include #include "ResourceManager.h" #include "NetworkClient.h" #include "NetworkServer.h" @@ -13,10 +18,6 @@ #include "RGBController.h" #include "i2c_smbus.h" #include "LogManager.h" -#include -#include -#include -#include #ifdef _MACOSX_X86_X64 #include "macUSPCIOAccess.h" diff --git a/wmi/wmi.cpp b/wmi/wmi.cpp index 3bda9e23..7882f436 100644 --- a/wmi/wmi.cpp +++ b/wmi/wmi.cpp @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| wmi.cpp | +| | +| WMI interface functionality | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #include "wmi.h" IWbemLocator* Wmi::pLoc = nullptr; diff --git a/wmi/wmi.h b/wmi/wmi.h index 1963eb72..bb0d9145 100644 --- a/wmi/wmi.h +++ b/wmi/wmi.h @@ -1,3 +1,12 @@ +/*---------------------------------------------------------*\ +| wmi.h | +| | +| WMI interface functionality | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + #pragma once #include