aboutsummaryrefslogtreecommitdiffstats
path: root/docs/checks/README-mutable-container-key.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/checks/README-mutable-container-key.md')
-rw-r--r--docs/checks/README-mutable-container-key.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/checks/README-mutable-container-key.md b/docs/checks/README-mutable-container-key.md
new file mode 100644
index 00000000..1c87c017
--- /dev/null
+++ b/docs/checks/README-mutable-container-key.md
@@ -0,0 +1,5 @@
+# mutable-container-key
+
+Looks for `QMap` or `QHash` having key types which can be modified due to external factors.
+The key's value should never change, as it's needed for sorting or hashing, but with some types, such as non-owning smart pointers it might happen.
+The supported key types are: `QPointer`, `QWeakPointer`, `weak_ptr` and `QPersistentModelIndex`.