docs: describe MainWindow constructor parameters

This commit is contained in:
mandlm 2024-03-23 11:53:44 +01:00
parent 0288e8de9d
commit 532e52cc7f
Signed by: mandlm
GPG Key ID: 4AA25D647AA54CC7

View File

@ -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();