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.7 KiB
C++
73 lines
1.7 KiB
C++
/*
|
|
* Copyright (c) 2011 Tamas Krutki <ktamasw@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, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef MODULE_H
|
|
#define MODULE_H
|
|
|
|
#include <KCModule>
|
|
#include <KSharedConfig>
|
|
|
|
namespace Ui
|
|
{
|
|
class Module;
|
|
}
|
|
|
|
class KJob;
|
|
|
|
class Module : public KCModule
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param parent Parent widget of the module
|
|
* @param args Arguments for the module
|
|
*/
|
|
explicit Module(QWidget *parent, const QVariantList &args = QVariantList());
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
~Module() override;
|
|
void load() override;
|
|
void save() override;
|
|
void defaults() override;
|
|
|
|
protected Q_SLOTS:
|
|
|
|
/**
|
|
* Called when the import script button is clicked.
|
|
*/
|
|
void importScript();
|
|
|
|
void importScriptInstallFinished(KJob *job);
|
|
|
|
private:
|
|
/**
|
|
* UI
|
|
*/
|
|
Ui::Module *ui;
|
|
/**
|
|
* Updates the contents of the list view.
|
|
*/
|
|
void updateListViewContents();
|
|
KSharedConfigPtr m_kwinConfig;
|
|
};
|
|
|
|
#endif // MODULE_H
|