From 3d0197fa5e6c4209d021398415f779994c21bd24 Mon Sep 17 00:00:00 2001
From: isanae <14251494+isanae@users.noreply.github.com>
Date: Fri, 1 Nov 2019 06:47:53 -0400
Subject: comments

---
 src/lockwidget.h | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'src')

diff --git a/src/lockwidget.h b/src/lockwidget.h
index 18ff76dd..d3ff2f7d 100644
--- a/src/lockwidget.h
+++ b/src/lockwidget.h
@@ -5,22 +5,40 @@
 class LockWidget
 {
 public:
+  // reason to show the widget
+  //
   enum Reasons
   {
     NoReason = 0,
+
+    // lock the ui
     LockUI,
+
+    // because the output is required
     OutputRequired,
+
+    // to prevent exiting until all processes are completed
     PreventExit
   };
 
+  // returned by result()
+  //
   enum Results
   {
     NoResult = 0,
+
+    // the widget is still up
     StillLocked,
+
+    // force unlock was clicked
     ForceUnlocked,
+
+    // cancel was clicked
     Cancelled
   };
 
+  // if `reason` is not NoReason, lock() is called with it
+  //
   LockWidget(QWidget* parent, Reasons reason=NoReason);
   ~LockWidget();
 
-- 
cgit v1.3.1