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

Update yet more file header comments to standardized new format

Browse source
This commit is contained in:
Adam Honse 2024-05-03 21:56:32 -05:00
parent a3066db16c
commit a7c400bc65
26 changed files with 288 additions and 133 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Colors.h
View file

@ -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 #ifndef COLORS_H
#define COLORS_H #define COLORS_H

9
Detector.h
View file

@ -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 #pragma once
#include "DeviceDetector.h" #include "DeviceDetector.h"

9
DeviceDetector.h
View file

@ -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 #pragma once
#include <functional> #include <functional>

9
LogManager.cpp
View file

@ -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 "LogManager.h"
#include <stdarg.h> #include <stdarg.h>

9
LogManager.h
View file

@ -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 #ifndef LOGMANAGER_H
#define LOGMANAGER_H #define LOGMANAGER_H

19
NetworkClient.cpp
View file

@ -1,14 +1,17 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| NetworkClient.cpp | | NetworkClient.cpp |
| | | |
| Client code for OpenRGB SDK | | OpenRGB SDK network client |
| | | |
| Adam Honse (CalcProgrammer1) 5/9/2020 | | Adam Honse (CalcProgrammer1) 09 May 2020 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <cstring>
#include "NetworkClient.h" #include "NetworkClient.h"
#include "RGBController_Network.h" #include "RGBController_Network.h"
#include <cstring>
#ifdef _WIN32 #ifdef _WIN32
#include <Windows.h> #include <Windows.h>

26
NetworkClient.h
View file

@ -1,19 +1,21 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| NetworkClient.h | | NetworkClient.h |
| | | |
| Client header for OpenRGB SDK | | OpenRGB SDK network client |
| | | |
| Adam Honse (CalcProgrammer1) 5/9/2020 | | Adam Honse (CalcProgrammer1) 09 May 2020 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "RGBController.h" #pragma once
#include "NetworkProtocol.h"
#include "net_port.h"
#include <mutex> #include <mutex>
#include <thread> #include <thread>
#include "RGBController.h"
#pragma once #include "NetworkProtocol.h"
#include "net_port.h"
typedef void (*NetClientCallback)(void *); typedef void (*NetClientCallback)(void *);

13
NetworkProtocol.cpp
View file

@ -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 <cstring> #include <cstring>
#include "NetworkProtocol.h"
/*-----------------------------------------------------*\ /*-----------------------------------------------------*\
| OpenRGB SDK Magic Value "ORGB" | | OpenRGB SDK Magic Value "ORGB" |

17
NetworkProtocol.h
View file

@ -1,10 +1,13 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| NetworkProtocol.h | | NetworkProtocol.h |
| | | |
| Protocol header for OpenRGB SDK | | OpenRGB SDK network protocol |
| | | |
| Adam Honse (CalcProgrammer1) 5/9/2020 | | Adam Honse (CalcProgrammer1) 09 May 2020 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once #pragma once

19
NetworkServer.cpp
View file

@ -1,14 +1,17 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| NetworkServer.cpp | | NetworkServer.cpp |
| | | |
| Server code for OpenRGB SDK | | OpenRGB SDK network server |
| | | |
| Adam Honse (CalcProgrammer1) 5/9/2020 | | Adam Honse (CalcProgrammer1) 09 May 2020 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <cstring>
#include "NetworkServer.h" #include "NetworkServer.h"
#include "LogManager.h" #include "LogManager.h"
#include <cstring>
#ifndef WIN32 #ifndef WIN32
#include <sys/ioctl.h> #include <sys/ioctl.h>

28
NetworkServer.h
View file

@ -1,21 +1,23 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| NetworkServer.h | | NetworkServer.h |
| | | |
| Server header for OpenRGB SDK | | OpenRGB SDK network server |
| | | |
| Adam Honse (CalcProgrammer1) 5/9/2020 | | Adam Honse (CalcProgrammer1) 09 May 2020 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "RGBController.h" #pragma once
#include "NetworkProtocol.h"
#include "net_port.h"
#include "ProfileManager.h"
#include <mutex> #include <mutex>
#include <thread> #include <thread>
#include <chrono> #include <chrono>
#include "RGBController.h"
#pragma once #include "NetworkProtocol.h"
#include "net_port.h"
#include "ProfileManager.h"
#define MAXSOCK 32 #define MAXSOCK 32
#define TCP_TIMEOUT_SECONDS 5 #define TCP_TIMEOUT_SECONDS 5

22
OpenRGBPluginInterface.h
View file

@ -1,19 +1,21 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| OpenRGBPluginInterface.h | | OpenRGBPluginInterface.h |
| | | |
| OpenRGB Plugin Interface Class | | OpenRGB SDK network protocol |
| | | |
| herosilas12 (CoffeeIsLife) 12/11/2020 | | herosilas12 (CoffeeIsLife) 11 Dec 2020 |
| Adam Honse (CalcProgrammer1) 1/5/2021 | | Adam Honse (CalcProgrammer1) 05 Jan 2021 |
\*-----------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once #pragma once
#include "ResourceManager.h"
#include <QtPlugin> #include <QtPlugin>
#include <QLabel> #include <QLabel>
#include <QMenu> #include <QMenu>
#include "ResourceManager.h"
#define OpenRGBPluginInterface_IID "com.OpenRGBPluginInterface" #define OpenRGBPluginInterface_IID "com.OpenRGBPluginInterface"

9
PluginManager.cpp
View file

@ -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 "LogManager.h"
#include "filesystem.h" #include "filesystem.h"
#include "PluginManager.h" #include "PluginManager.h"

17
PluginManager.h
View file

@ -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 #pragma once
#include "OpenRGBPluginInterface.h" #include <string>
#include <iostream>
#include <QPluginLoader> #include <QPluginLoader>
#include <QLabel> #include <QLabel>
#include <QtPlugin> #include <QtPlugin>
#include <QDir> #include <QDir>
#include "OpenRGBPluginInterface.h"
#include <string>
#include <iostream>
typedef struct typedef struct
{ {

15
ProfileManager.cpp
View file

@ -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 <fstream>
#include <iostream>
#include <cstring>
#include "ProfileManager.h" #include "ProfileManager.h"
#include "ResourceManager.h" #include "ResourceManager.h"
#include "RGBController_Dummy.h" #include "RGBController_Dummy.h"
#include "LogManager.h" #include "LogManager.h"
#include "NetworkProtocol.h" #include "NetworkProtocol.h"
#include "filesystem.h" #include "filesystem.h"
#include <fstream>
#include <iostream>
#include <cstring>
#include "StringUtils.h" #include "StringUtils.h"
#define OPENRGB_PROFILE_HEADER "OPENRGB_PROFILE" #define OPENRGB_PROFILE_HEADER "OPENRGB_PROFILE"

10
ProfileManager.h
View file

@ -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 #pragma once
#include "RGBController.h" #include "RGBController.h"
#include "filesystem.h" #include "filesystem.h"
class ProfileManagerInterface class ProfileManagerInterface

39
ResourceManager.cpp
View file

@ -1,22 +1,15 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| ResourceManager.cpp | | ResourceManager.cpp |
| | | |
| OpenRGB Resource Manager controls access | | OpenRGB Resource Manager controls access to application |
| to application components including | | components including RGBControllers, I2C interfaces, |
| RGBControllers, I2C interfaces, and | | and network SDK components |
| network SDK components | | |
| | | Adam Honse (CalcProgrammer1) 27 Sep 2020 |
| Adam Honse (CalcProgrammer1) 9/27/2020 | | |
\*-----------------------------------------*/ | This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
#include "ResourceManager.h" \*---------------------------------------------------------*/
#include "ProfileManager.h"
#include "LogManager.h"
#include "SettingsManager.h"
#include "NetworkClient.h"
#include "NetworkServer.h"
#include "filesystem.h"
#include "StringUtils.h"
#ifdef _WIN32 #ifdef _WIN32
#include <codecvt> #include <codecvt>
@ -26,6 +19,14 @@
#include <stdlib.h> #include <stdlib.h>
#include <string> #include <string>
#include <hidapi/hidapi.h> #include <hidapi/hidapi.h>
#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 = const hidapi_wrapper default_wrapper =
{ {

23
ResourceManager.h
View file

@ -1,13 +1,15 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| ResourceManager.h | | ResourceManager.h |
| | | |
| OpenRGB Resource Manager controls access | | OpenRGB Resource Manager controls access to application |
| to application components including | | components including RGBControllers, I2C interfaces, |
| RGBControllers, I2C interfaces, and | | and network SDK components |
| network SDK components | | |
| | | Adam Honse (CalcProgrammer1) 27 Sep 2020 |
| Adam Honse (CalcProgrammer1) 9/27/2020 | | |
\*-----------------------------------------*/ | This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once #pragma once
@ -16,7 +18,6 @@
#include <functional> #include <functional>
#include <thread> #include <thread>
#include <string> #include <string>
#include "hidapi_wrapper.h" #include "hidapi_wrapper.h"
#include "i2c_smbus.h" #include "i2c_smbus.h"
#include "filesystem.h" #include "filesystem.h"

27
SettingsManager.cpp
View file

@ -1,19 +1,20 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| SettingsManager.cpp | | SettingsManager.cpp |
| | | |
| OpenRGB Settings Manager maintains a list| | OpenRGB Settings Manager maintains a list of application|
| of application settings in JSON format. | | settings in JSON format. Other components may register |
| Other components may register settings | | settings with this class and store/load values. |
| with this class and store/load values. | | |
| | | Adam Honse (CalcProgrammer1) 04 Nov 2020 |
| Adam Honse (CalcProgrammer1) 11/4/2020 | | |
\*-----------------------------------------*/ | This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
#include "SettingsManager.h" \*---------------------------------------------------------*/
#include "LogManager.h"
#include <fstream> #include <fstream>
#include <iostream> #include <iostream>
#include "SettingsManager.h"
#include "LogManager.h"
SettingsManager::SettingsManager() SettingsManager::SettingsManager()
{ {

22
SettingsManager.h
View file

@ -1,13 +1,15 @@
/*-----------------------------------------*\ /*---------------------------------------------------------*\
| SettingsManager.h | | SettingsManager.h |
| | | |
| OpenRGB Settings Manager maintains a list| | OpenRGB Settings Manager maintains a list of application|
| of application settings in JSON format. | | settings in JSON format. Other components may register |
| Other components may register settings | | settings with this class and store/load values. |
| with this class and store/load values. | | |
| | | Adam Honse (CalcProgrammer1) 04 Nov 2020 |
| Adam Honse (CalcProgrammer1) 11/4/2020 | | |
\*-----------------------------------------*/ | This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once #pragma once

11
StringUtils.cpp
View file

@ -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 <string> #include <string>
#include "StringUtils.h"
const char* StringUtils::wchar_to_char(const wchar_t* pwchar) const char* StringUtils::wchar_to_char(const wchar_t* pwchar)
{ {

9
StringUtils.h
View file

@ -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 #ifndef STRING_UTILS_H
#define STRING_UTILS_H #define STRING_UTILS_H

9
filesystem.h
View file

@ -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 #ifndef FILESYSTEM_H
#define FILESYSTEM_H #define FILESYSTEM_H

23
main.cpp
View file

@ -1,11 +1,16 @@
/******************************************************************************************\ /*---------------------------------------------------------*\
* * | main.cpp |
* main.cpp * | |
* * | Entry point for the OpenRGB application |
* Main function for OpenAuraSDK GUI project * | |
* * | This file is part of the OpenRGB project |
\******************************************************************************************/ | SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <vector>
#include <stdio.h>
#include <stdlib.h>
#include <thread>
#include "ResourceManager.h" #include "ResourceManager.h"
#include "NetworkClient.h" #include "NetworkClient.h"
#include "NetworkServer.h" #include "NetworkServer.h"
@ -13,10 +18,6 @@
#include "RGBController.h" #include "RGBController.h"
#include "i2c_smbus.h" #include "i2c_smbus.h"
#include "LogManager.h" #include "LogManager.h"
#include <vector>
#include <stdio.h>
#include <stdlib.h>
#include <thread>
#ifdef _MACOSX_X86_X64 #ifdef _MACOSX_X86_X64
#include "macUSPCIOAccess.h" #include "macUSPCIOAccess.h"

9
wmi/wmi.cpp
View file

@ -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" #include "wmi.h"
IWbemLocator* Wmi::pLoc = nullptr; IWbemLocator* Wmi::pLoc = nullptr;

9
wmi/wmi.h
View file

@ -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 #pragma once
#include <string> #include <string>