aboutsummaryrefslogtreecommitdiffstats
path: root/src/ui/widgets/HelpPage.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/ui/widgets/HelpPage.h')
-rw-r--r--src/ui/widgets/HelpPage.h65
1 files changed, 45 insertions, 20 deletions
diff --git a/src/ui/widgets/HelpPage.h b/src/ui/widgets/HelpPage.h
index 25490557..0b0db5ea 100644
--- a/src/ui/widgets/HelpPage.h
+++ b/src/ui/widgets/HelpPage.h
@@ -1,22 +1,29 @@
-/*
- * helppage.h
+/**
+ * Copyright (C) 2021 Saturneric
*
- * Copyright 2008 gpg4usb-team <[email protected]>
+ * This file is part of GpgFrontend.
*
- * This file is part of gpg4usb.
+ * GpgFrontend 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 3 of the License, or
+ * (at your option) any later version.
*
- * Gpg4usb 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 3 of the License, or
- * (at your option) any later version.
+ * GpgFrontend 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.
*
- * Gpg4usb 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 GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The initial version of the source code is inherited from
+ * the gpg4usb project, which is under GPL-3.0-or-later.
+ *
+ * All the source code of GpgFrontend was modified and released by
+ * Saturneric<[email protected]> starting on May 12, 2021.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
*
- * You should have received a copy of the GNU General Public License
- * along with gpg4usb. If not, see <http://www.gnu.org/licenses/>
*/
#ifndef HELPPAGE_H
@@ -26,22 +33,40 @@
namespace GpgFrontend::UI {
+/**
+ * @brief
+ *
+ */
class HelpPage : public QWidget {
Q_OBJECT
public:
+ /**
+ * @brief Construct a new Help Page object
+ *
+ * @param path
+ * @param parent
+ */
explicit HelpPage(const QString& path, QWidget* parent = nullptr);
- QTextBrowser* getBrowser();
-
- signals:
+ /**
+ * @brief Get the Browser object
+ *
+ * @return QTextBrowser*
+ */
+ QTextBrowser* GetBrowser();
public slots:
- void slotOpenUrl(const QUrl& url);
+ /**
+ * @brief
+ *
+ * @param url
+ */
+ void slot_open_url(const QUrl& url);
private:
- QTextBrowser* browser; /** The textbrowser of the tab */
- QUrl localizedHelp(const QUrl& path);
+ QTextBrowser* browser_; ///< The textbrowser of the tab
+ QUrl localized_help(const QUrl& path);
};
} // namespace GpgFrontend::UI