From 2c6afddee32f41390aa0a498c14955d2fbe04600 Mon Sep 17 00:00:00 2001
From: Martchus <martchus@gmx.net>
Date: Sun, 19 Jun 2022 13:46:01 +0200
Subject: [PATCH] Document all member functions of `TagFieldEdit`

---
 gui/tagfieldedit.cpp | 3 +++
 gui/tagfieldedit.h   | 5 +++++
 2 files changed, 8 insertions(+)

diff --git a/gui/tagfieldedit.cpp b/gui/tagfieldedit.cpp
index b017d07..8df0773 100644
--- a/gui/tagfieldedit.cpp
+++ b/gui/tagfieldedit.cpp
@@ -217,6 +217,9 @@ bool TagFieldEdit::canApply(KnownField field) const
     return false;
 }
 
+/*!
+ * \brief Sets whether the tag field edit is locked to keep the current value when switching files.
+ */
 void TagFieldEdit::setLocked(bool locked)
 {
     if (locked == m_isLocked) {
diff --git a/gui/tagfieldedit.h b/gui/tagfieldedit.h
index d656985..42d9774 100644
--- a/gui/tagfieldedit.h
+++ b/gui/tagfieldedit.h
@@ -109,26 +109,31 @@ private:
     bool m_autoCorrectionApplied;
 };
 
+/// \brief Returns the currently assigned tags.
 inline const QList<TagParser::Tag *> &TagFieldEdit::tags() const
 {
     return *m_tags;
 }
 
+/// \brief Returns the currently assigned field.
 inline TagParser::KnownField TagFieldEdit::field() const
 {
     return m_field;
 }
 
+/// \brief Returns whether the tag field edit is locked to keep the current value when switching files.
 inline bool TagFieldEdit::isLocked() const
 {
     return m_isLocked;
 }
 
+/// \brief Toggles whether the tag field edit is locked to keep the current value when switching files.
 inline void TagFieldEdit::toggleLocked()
 {
     setLocked(!isLocked());
 }
 
+/// \brief Returns whether auto correction has been applied.
 inline bool TagFieldEdit::hasAutoCorrectionBeenApplied() const
 {
     return m_autoCorrectionApplied;