summaryrefslogtreecommitdiff
path: root/src/libs/utils/submitfieldwidget.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/libs/utils/submitfieldwidget.cpp')
-rw-r--r--src/libs/utils/submitfieldwidget.cpp12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/libs/utils/submitfieldwidget.cpp b/src/libs/utils/submitfieldwidget.cpp
index 0919c376a0..07378fd5d2 100644
--- a/src/libs/utils/submitfieldwidget.cpp
+++ b/src/libs/utils/submitfieldwidget.cpp
@@ -55,6 +55,18 @@ static void inline setComboBlocked(QComboBox *cb, int index)
cb->blockSignals(blocked);
}
+/*!
+ \class Utils::SubmitFieldWidget
+ \brief A widget for editing submit message fields like "reviewed-by:",
+ "signed-off-by:".
+
+ It displays them in a vertical row of combo/line edit fields
+ that is modeled after the target address controls of mail clients.
+ When choosing a different field in the combo, a new row is opened if text
+ has been entered for the current field. Optionally, a "Browse..." button and
+ completer can be added.
+*/
+
namespace Utils {
// Field/Row entry