aboutsummaryrefslogtreecommitdiffstats
path: root/docs/checks/README-missing-qobject-macro.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/checks/README-missing-qobject-macro.md')
-rw-r--r--docs/checks/README-missing-qobject-macro.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/checks/README-missing-qobject-macro.md b/docs/checks/README-missing-qobject-macro.md
new file mode 100644
index 00000000..4b56013a
--- /dev/null
+++ b/docs/checks/README-missing-qobject-macro.md
@@ -0,0 +1,17 @@
+# missing-qobject-macro
+
+Finds `QObject` derived classes that don't have a Q_OBJECT macro.
+
+#### Reasons to use Q_OBJECT
+- Signals and slots
+- `QObject::inherits`
+- `qobject_cast`
+- `metaObject()->className()`
+- Use your custom widget as a selector in Qt stylesheets
+
+#### Reasons not to use Q_OBJECT
+- Templated QObjects
+- Compilation time
+
+This check can't be used with pre-compiled headers support.
+This check doesn't have false positives, but it's not included in level <= 1 because the missing Q_OBJECT might be intentional.