Update even more file header comments to standardized new format

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

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;

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

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"

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

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"

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

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>

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