aboutsummaryrefslogtreecommitdiffstats
path: root/docs/checks/README-connect-not-normalized.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/checks/README-connect-not-normalized.md')
-rw-r--r--docs/checks/README-connect-not-normalized.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/checks/README-connect-not-normalized.md b/docs/checks/README-connect-not-normalized.md
new file mode 100644
index 00000000..3931fd69
--- /dev/null
+++ b/docs/checks/README-connect-not-normalized.md
@@ -0,0 +1,10 @@
+# connect-not-normalized
+
+Warns when the contents of `SIGNAL()`, `SLOT()`, `Q_ARG()` and `Q_RETURN_ARG()` are not normalized.
+
+Using normalized signatures allows to avoid unneeded memory allocations.
+
+For signals and slots it only warns for `connect` statements, not `disconnect`, since it only
+impacts the performance of the former.
+
+See `QMetaObject::normalizedSignature()` for more information.