1 files changed, 26 insertions, 0 deletions
diff --git a/docs/checks/README-fully-qualified-moc-types.md b/docs/checks/README-fully-qualified-moc-types.md
new file mode 100644
index 00000000..43f34055
--- /dev/null
+++ b/docs/checks/README-fully-qualified-moc-types.md
@@ -0,0 +1,26 @@
+# fully-qualified-moc-types
+
+Warns when a signal, slot or invokable declaration is not using fully-qualified type names, which will break old-style connects
+and interaction with QML.
+
+Also warns if a Q_PROPERTY of type gadget is not fully-qualified (Enums and QObjects in Q_PROPERTY don't need
+to be fully qualified).
+
+Example:
+
+namespace MyNameSpace {
+
+    struct MyType { (...) };
+
+    class MyObject : public QObject
+    {
+        Q_OBJECT
+        Q_PROPERTY(MyGadget myprop READ myprop); // Wrong, needs namespace
+    Q_SIGNALS:
+        void mySignal(MyType); // Wrong
+        void mySignal(MyNameSpace::MyType); // OK
+    };
+}
+
+Beware that fixing these type names might break user code if they are connecting to them via old style connects,
+since the users might have worked around your bug and not included the namespace in their connect statement