Even more file header comment updates to standardized new format

This commit is contained in:
Adam Honse 2024-05-04 01:27:12 -05:00
parent a7c400bc65
commit 4f951c13c6
14 changed files with 157 additions and 49 deletions

View file

@ -1,5 +1,13 @@
#include "DetectorTableModel.h" /*---------------------------------------------------------*\
| DetectorTableModel.cpp |
| |
| Table model for detector list |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "DetectorTableModel.h"
#include "SettingsManager.h" #include "SettingsManager.h"
DetectorTableModel::DetectorTableModel(QObject* parent) : QAbstractTableModel(parent) DetectorTableModel::DetectorTableModel(QObject* parent) : QAbstractTableModel(parent)

View file

@ -1,5 +1,13 @@
#ifndef DETECTORTABLEMODEL_H /*---------------------------------------------------------*\
#define DETECTORTABLEMODEL_H | DetectorTableModel.h |
| |
| Table model for detector list |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include <QSortFilterProxyModel> #include <QSortFilterProxyModel>
#include <QAbstractTableModel> #include <QAbstractTableModel>
@ -31,5 +39,3 @@ public slots:
void applySettings(); void applySettings();
void toggleAll(const bool state, QSortFilterProxyModel* detectorSortModel); void toggleAll(const bool state, QSortFilterProxyModel* detectorSortModel);
}; };
#endif // DETECTORTABLEMODEL_H

View file

@ -1,22 +1,25 @@
/*-----------------------------------------------------*\ /*---------------------------------------------------------*\
| DeviceView.cpp | | DeviceView.cpp |
| | | |
| OpenRGB Device view widget for Qt | | OpenRGB Device view widget for Qt |
| | | |
| Adam Honse (calcprogrammer1@gmail.com) | | Adam Honse (calcprogrammer1@gmail.com) |
\*-----------------------------------------------------*/ | |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "DeviceView.h"
#include "ResourceManager.h"
#include "RGBControllerKeyNames.h"
#include "RGBController.h"
#include "SettingsManager.h"
#include <QPainter> #include <QPainter>
#include <QResizeEvent> #include <QResizeEvent>
#include <QStyleOption> #include <QStyleOption>
#include <QtCore/qmath.h> #include <QtCore/qmath.h>
#include <QDebug> #include <QDebug>
#include <QMouseEvent> #include <QMouseEvent>
#include "DeviceView.h"
#include "ResourceManager.h"
#include "RGBControllerKeyNames.h"
#include "RGBController.h"
#include "SettingsManager.h"
#define MAX_COLS 20 #define MAX_COLS 20
#define PAD_LED 0.1f #define PAD_LED 0.1f

View file

@ -1,5 +1,15 @@
#ifndef DEVICEVIEW_H /*---------------------------------------------------------*\
#define DEVICEVIEW_H | DeviceView.h |
| |
| OpenRGB Device view widget for Qt |
| |
| Adam Honse (calcprogrammer1@gmail.com) |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include <QWidget> #include <QWidget>
#include "RGBController.h" #include "RGBController.h"
@ -74,5 +84,3 @@ public slots:
void clearSelection(); // Same as selecting the entire device void clearSelection(); // Same as selecting the entire device
void setSelectionColor(RGBColor); void setSelectionColor(RGBColor);
}; };
#endif // DEVICEVIEW_H

View file

@ -1,10 +1,21 @@
#include "OpenRGBFont.h" /*---------------------------------------------------------*\
| OpenRGBFont.cpp |
| |
| Functionality for OpenRGB custom font icons |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <QStringList> #include <QStringList>
#include <QFontDatabase> #include <QFontDatabase>
#include "OpenRGBFont.h"
OpenRGBFont* OpenRGBFont::instance; OpenRGBFont* OpenRGBFont::instance;
OpenRGBFont::OpenRGBFont(){} OpenRGBFont::OpenRGBFont()
{
}
OpenRGBFont *OpenRGBFont::Get() OpenRGBFont *OpenRGBFont::Get()
{ {

View file

@ -1,5 +1,13 @@
#ifndef OPENRGBFONT_H /*---------------------------------------------------------*\
#define OPENRGBFONT_H | OpenRGBFont.h |
| |
| Functionality for OpenRGB custom font icons |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include <QFont> #include <QFont>
#include <QString> #include <QString>
@ -9,7 +17,8 @@ class OpenRGBFont
public: public:
static OpenRGBFont* Get(); static OpenRGBFont* Get();
enum Glyph { enum Glyph
{
bulb = 0xF001, bulb = 0xF001,
controller = 0xF002, controller = 0xF002,
cooler = 0xF003, cooler = 0xF003,
@ -50,5 +59,3 @@ private:
int fontId = -1; int fontId = -1;
QFont font; QFont font;
}; };
#endif // OPENRGBFONT_H

View file

@ -1,7 +1,12 @@
#include "OpenRGBThemeManager.h" /*---------------------------------------------------------*\
#include "ResourceManager.h" | OpenRGBThemeManager.cpp |
#include "PluginManager.h" | |
#include "SettingsManager.h" | Functionality for managing dark theme mode |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <QApplication> #include <QApplication>
#include <QWidget> #include <QWidget>
#include <QStyle> #include <QStyle>
@ -12,6 +17,11 @@
#include <QSettings> #include <QSettings>
#endif #endif
#include "OpenRGBThemeManager.h"
#include "ResourceManager.h"
#include "PluginManager.h"
#include "SettingsManager.h"
void OpenRGBThemeManager::Init() void OpenRGBThemeManager::Init()
{ {

View file

@ -1,5 +1,13 @@
#ifndef OPENRGBTHEMEMANAGER_H /*---------------------------------------------------------*\
#define OPENRGBTHEMEMANAGER_H | OpenRGBThemeManager.h |
| |
| Functionality for managing dark theme mode |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include <string> #include <string>
@ -10,5 +18,3 @@ public:
static void SetDarkTheme(); static void SetDarkTheme();
static bool IsDarkTheme(); static bool IsDarkTheme();
}; };
#endif // OPENRGBTHEMEMANAGER_H

View file

@ -1,9 +1,18 @@
#include "QTooltipedSlider.h" /*---------------------------------------------------------*\
| QTooltipedSlider.cpp |
| |
| Qt widget for OpenRGB tooltiped slider |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <QToolTip> #include <QToolTip>
#include "QTooltipedSlider.h"
QTooltipedSlider::QTooltipedSlider(QWidget *parent) : QTooltipedSlider::QTooltipedSlider(QWidget *parent) :
QSlider(parent) QSlider(parent)
{ {
connect(this, &QSlider::sliderMoved,[&](int value) { connect(this, &QSlider::sliderMoved,[&](int value) {
QToolTip::showText(QCursor::pos(), QString("%1").arg(value), nullptr); QToolTip::showText(QCursor::pos(), QString("%1").arg(value), nullptr);
}); });

View file

@ -1,5 +1,13 @@
#ifndef QTOOLTIPEDSLIDER_H /*---------------------------------------------------------*\
#define QTOOLTIPEDSLIDER_H | QTooltipedSlider.h |
| |
| Qt widget for OpenRGB tooltiped slider |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include <QSlider> #include <QSlider>
@ -10,5 +18,3 @@ class QTooltipedSlider : public QSlider
public: public:
explicit QTooltipedSlider(QWidget *parent = nullptr); explicit QTooltipedSlider(QWidget *parent = nullptr);
}; };
#endif // QTOOLTIPEDSLIDER_H

View file

@ -1,5 +1,14 @@
#include "TabLabel.h" /*---------------------------------------------------------*\
| TabLabel.cpp |
| |
| Qt widget for OpenRGB tab label |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <QFontMetrics> #include <QFontMetrics>
#include "TabLabel.h"
#include "OpenRGBFont.h" #include "OpenRGBFont.h"
Ui::TabLabel::TabLabel(int icon, QString name, char* original, char* context) : Ui::TabLabel::TabLabel(int icon, QString name, char* original, char* context) :

View file

@ -1,11 +1,20 @@
#ifndef TABLABEL_H /*---------------------------------------------------------*\
#define TABLABEL_H | TabLabel.h |
| |
| Qt widget for OpenRGB tab label |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include <QWidget> #include <QWidget>
#include "ui_TabLabel.h" #include "ui_TabLabel.h"
namespace Ui { namespace Ui
class TabLabel; {
class TabLabel;
} }
class Ui::TabLabel : public QWidget class Ui::TabLabel : public QWidget
@ -24,5 +33,3 @@ private:
private slots: private slots:
void changeEvent(QEvent *event); void changeEvent(QEvent *event);
}; };
#endif // TABLABEL_H

View file

@ -1,3 +1,12 @@
/*---------------------------------------------------------*\
| macutils.h |
| |
| Utility function for dockless mode in MacOS |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#ifndef MACUTILS_H #ifndef MACUTILS_H
#define MACUTILS_H #define MACUTILS_H

View file

@ -1,3 +1,12 @@
/*---------------------------------------------------------*\
| macutils.mm |
| |
| Utility function for dockless mode in MacOS |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#import <Cocoa/Cocoa.h> #import <Cocoa/Cocoa.h>
#include "macutils.h" #include "macutils.h"