From cc973d1ea5bb41c30769ae0eae7ae0a76adb168f Mon Sep 17 00:00:00 2001
From: Gioacchino Mazzurco <gio@eigenlab.org>
Date: Tue, 16 Apr 2019 17:10:46 +0200
Subject: [PATCH] Add a bit of documentation about broadcast discovery event

---
 libretroshare/src/retroshare/rsbroadcastdiscovery.h | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/libretroshare/src/retroshare/rsbroadcastdiscovery.h b/libretroshare/src/retroshare/rsbroadcastdiscovery.h
index 2322477f1..09a4eafb1 100644
--- a/libretroshare/src/retroshare/rsbroadcastdiscovery.h
+++ b/libretroshare/src/retroshare/rsbroadcastdiscovery.h
@@ -43,6 +43,7 @@ class RsBroadcastDiscovery;
  */
 extern std::shared_ptr<RsBroadcastDiscovery> rsBroadcastDiscovery;
 
+
 struct RsBroadcastDiscoveryResult : RsSerializable
 {
 	PGPFingerprintType mPgpFingerprint;
@@ -65,6 +66,11 @@ struct RsBroadcastDiscoveryResult : RsSerializable
 	~RsBroadcastDiscoveryResult() override;
 };
 
+
+/**
+ * @brief Event emitted when a non friend new peer is found in the local network
+ * @see RsEvents
+ */
 struct RsBroadcastDiscoveryPeerFoundEvent : RsEvent
 {
 	RsBroadcastDiscoveryPeerFoundEvent(
@@ -84,6 +90,7 @@ struct RsBroadcastDiscoveryPeerFoundEvent : RsEvent
 	~RsBroadcastDiscoveryPeerFoundEvent() override;
 };
 
+
 /**
  * Announce own RetroShare instace and look friends and peers in own broadcast
  * domain (aka LAN).