kwin/effects/invert/invert.h
Vlad Zagorodniy 684b4b635e Use more traditional doxygen style
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
2019-07-29 22:06:19 +03:00

75 lines
1.9 KiB
C++

/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2007 Rivo Laks <rivolaks@hot.ee>
Copyright (C) 2008 Lucas Murray <lmurray@undefinedfire.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/>.
*********************************************************************/
#ifndef KWIN_INVERT_H
#define KWIN_INVERT_H
#include <kwineffects.h>
namespace KWin
{
class GLShader;
/**
* Inverts desktop's colors
*/
class InvertEffect
: public Effect
{
Q_OBJECT
public:
InvertEffect();
~InvertEffect() override;
void drawWindow(EffectWindow* w, int mask, QRegion region, WindowPaintData& data) override;
void paintEffectFrame(KWin::EffectFrame* frame, QRegion region, double opacity, double frameOpacity) override;
bool isActive() const override;
bool provides(Feature) override;
int requestedEffectChainPosition() const override;
static bool supported();
public Q_SLOTS:
void toggleScreenInversion();
void toggleWindow();
void slotWindowClosed(KWin::EffectWindow *w);
protected:
bool loadData();
private:
bool m_inited;
bool m_valid;
GLShader* m_shader;
bool m_allWindows;
QList<EffectWindow*> m_windows;
};
inline int InvertEffect::requestedEffectChainPosition() const
{
return 99;
}
} // namespace
#endif