684b4b635e
Summary:
So far we were following a bit unique and rare doxygen comment style:
/**
* Contents of the comment.
**/
Doxygen comments with this style look balanced and neat, but many people
that contribute to KWin don't follow this style. Instead, they prefer
more traditional doxygen comment style, i.e.
/**
* Contents of the comment.
*/
Reviewing such changes has been a bit frustrating for me (so selfish!)
and for other contributors.
This change switches doxygen comment style in KWin to a more traditional
style. The main reason for doing this is to make code review process easier
for new contributors as well us.
Reviewers: #kwin, davidedmundson
Reviewed By: #kwin, davidedmundson
Subscribers: kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D22812
73 lines
1.8 KiB
C++
73 lines
1.8 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright (C) 2019 Vlad Zagorodniy <vladzzag@gmail.com>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*********************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include <QByteArray>
|
|
#include <QSize>
|
|
|
|
namespace KWin
|
|
{
|
|
|
|
/**
|
|
* Helper class that can be used for parsing EDID blobs.
|
|
*
|
|
* http://read.pudn.com/downloads110/ebook/456020/E-EDID%20Standard.pdf
|
|
*/
|
|
class Edid
|
|
{
|
|
public:
|
|
Edid();
|
|
Edid(const void *data, uint32_t size);
|
|
|
|
/**
|
|
* Whether this instance of EDID is valid.
|
|
*/
|
|
bool isValid() const;
|
|
|
|
/**
|
|
* Returns physical dimensions of the monitor, in millimeters.
|
|
*/
|
|
QSize physicalSize() const;
|
|
|
|
/**
|
|
* Returns EISA ID of the manufacturer of the monitor.
|
|
*/
|
|
QByteArray eisaId() const;
|
|
|
|
/**
|
|
* Returns the product name of the monitor.
|
|
*/
|
|
QByteArray monitorName() const;
|
|
|
|
/**
|
|
* Returns the serial number of the monitor.
|
|
*/
|
|
QByteArray serialNumber() const;
|
|
|
|
private:
|
|
QSize m_physicalSize;
|
|
QByteArray m_eisaId;
|
|
QByteArray m_monitorName;
|
|
QByteArray m_serialNumber;
|
|
bool m_isValid = false;
|
|
};
|
|
|
|
} // namespace KWin
|