aboutsummaryrefslogtreecommitdiffstats
path: root/src/ui/widgets/HelpPage.h
diff options
context:
space:
mode:
authorSaturneric <[email protected]>2022-01-23 08:35:59 +0000
committerSaturneric <[email protected]>2022-01-23 08:35:59 +0000
commita7fb788cd0379bc3f49d5c0fdb0cbdf2b8401f7b (patch)
tree3299c2bcbddc0eb1fa0b9bb3ae002e5ac856180c /src/ui/widgets/HelpPage.h
parent<refactor>(ui): tidy up codes and comments. (diff)
downloadGpgFrontend-a7fb788cd0379bc3f49d5c0fdb0cbdf2b8401f7b.tar.gz
GpgFrontend-a7fb788cd0379bc3f49d5c0fdb0cbdf2b8401f7b.zip
<refactor>(ui): tidy up codes and comments.
1. tidy up widgets.
Diffstat (limited to 'src/ui/widgets/HelpPage.h')
-rw-r--r--src/ui/widgets/HelpPage.h30
1 files changed, 24 insertions, 6 deletions
diff --git a/src/ui/widgets/HelpPage.h b/src/ui/widgets/HelpPage.h
index 1406f779..0b0db5ea 100644
--- a/src/ui/widgets/HelpPage.h
+++ b/src/ui/widgets/HelpPage.h
@@ -33,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