From d137910aaf0ea08e2d5e17ec2ecdab13642ac7c5 Mon Sep 17 00:00:00 2001
From: Piyush Aggarwal <piyushaggarwal002@gmail.com>
Date: Sat, 14 Nov 2020 09:02:21 +0530
Subject: [PATCH] bigscreen: add comment on how this plugin is used

Currently bigscreenplugin emits a signal whose consumption point is not documented in our code.
This patch adds a link to a usecase of this emitted signal.
---
 plugins/bigscreen/bigscreenplugin.cpp | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/plugins/bigscreen/bigscreenplugin.cpp b/plugins/bigscreen/bigscreenplugin.cpp
index 79fda19f1..4177da141 100644
--- a/plugins/bigscreen/bigscreenplugin.cpp
+++ b/plugins/bigscreen/bigscreenplugin.cpp
@@ -30,6 +30,9 @@ BigscreenPlugin::~BigscreenPlugin() = default;
 bool BigscreenPlugin::receivePacket(const NetworkPacket& np)
 {
     QString message = np.get<QString>(QStringLiteral("content"));
+    /* Emit a signal that will be consumed by Plasma BigScreen:
+     * https://invent.kde.org/plasma/plasma-bigscreen/-/blob/master/containments/homescreen/package/contents/ui/indicators/KdeConnect.qml
+     */
     Q_EMIT messageReceived(message);
     return true;
 }