From 532e52cc7f035fefb6fd435e9f9b7dcc85f08487 Mon Sep 17 00:00:00 2001
From: Michael Mandl <mandlm@molez.net>
Date: Sat, 23 Mar 2024 11:53:44 +0100
Subject: [PATCH] docs: describe MainWindow constructor parameters

---
 QVectorSearch/mainwindow.h | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/QVectorSearch/mainwindow.h b/QVectorSearch/mainwindow.h
index 500214c..58d2178 100644
--- a/QVectorSearch/mainwindow.h
+++ b/QVectorSearch/mainwindow.h
@@ -3,10 +3,12 @@
 
 #include "finder.h"
 #include "word_list.h"
+
 #include <QMainWindow>
 #include <QStandardItemModel>
 #include <QStringListModel>
 #include <filesystem>
+#include <memory>
 
 QT_BEGIN_NAMESPACE
 namespace Ui {
@@ -26,14 +28,17 @@ private:
   bool incremental_search_enabled_;
 
 public:
+  /** Create a new MainWindow.
+   *
+   * @param[in] enableIncrementalSearch Run search while typing.
+   * @param[in] enableDevMode Show additional widgets to configure search.
+   */
   MainWindow(QWidget *parent = nullptr, bool enableIncrementalSearch = false,
              bool enableDevMode = false);
   ~MainWindow();
 
-  /// Show additional widgets
-  void setDevMode(bool enable);
-
 private:
+  void setDevMode(bool enable);
   void setupAlgorithmSelector();
   void setupWordListSourceSelector();
   void setupWordList();