diff options
Diffstat (limited to 'docs/checks/README-incorrect-emit.md')
| -rw-r--r-- | docs/checks/README-incorrect-emit.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/checks/README-incorrect-emit.md b/docs/checks/README-incorrect-emit.md new file mode 100644 index 00000000..09640675 --- /dev/null +++ b/docs/checks/README-incorrect-emit.md @@ -0,0 +1,8 @@ +# incorrect-emit + +For readability purposes you should always use emit (or Q_EMIT) when calling a signal. +Conversely, you should not use those macros when calling a non-signal. + +clazy will warn if you forget to use emit (or Q_EMIT) or if you use them on a non-signal. + +Additionally, it will warn when emitting a signal from a constructor, because there's nothing connected to the signal yet. |