From 575a416ee9394dbdbabce3f83dfb91c213c55bbb Mon Sep 17 00:00:00 2001
From: Konrad <KonradD@tutanota.com>
Date: Sat, 6 Jan 2018 19:09:44 +0100
Subject: [PATCH] Changed in Libresapi: Used Doxigen style comments

---
 libresapi/src/api/FileSharingHandler.h | 21 ++++++++++++++++-----
 libresapi/src/api/TransfersHandler.h   | 13 +++++++++++--
 2 files changed, 27 insertions(+), 7 deletions(-)

diff --git a/libresapi/src/api/FileSharingHandler.h b/libresapi/src/api/FileSharingHandler.h
index d2dad346f..086b7b45e 100644
--- a/libresapi/src/api/FileSharingHandler.h
+++ b/libresapi/src/api/FileSharingHandler.h
@@ -34,8 +34,10 @@ public:
 	FileSharingHandler(StateTokenServer* sts, RsFiles* files, RsNotify& notify);
 	~FileSharingHandler();
 
-	// from NotifyClient
-	// note: this may get called from foreign threads
+	/**
+	 Derived from NotifyClient
+	 This function may be called from foreign thread
+	*/
 	virtual void notifyListChange(int list, int type);
 
 private:
@@ -55,10 +57,19 @@ private:
 
 	void handleDownload(Request& req, Response& resp);
 
-	StateToken mLocalDirStateToken; // Token indicating change in local shared files
-	StateToken mRemoteDirStateToken; // Token indicating change in remote (friends') shared files
+	/// Token indicating change in local shared files
+	StateToken mLocalDirStateToken;
+
+	/// Token indicating change in remote (friends') shared files
+	StateToken mLocalDirStateToken;
+
 	StateTokenServer* mStateTokenServer;
-	RsMutex mMtx; // Inherited virtual functions of NotifyClient may be called from foreing thread
+
+	/**
+	 Protects mLocalDirStateToken and mLocalDirStateToken that may be changed in foreign thread
+	 @see FileSharingHandler::notifyListChange(...)
+	*/
+	RsMutex mMtx;
 
 	RsFiles* mRsFiles;
 	RsNotify& mNotify;
diff --git a/libresapi/src/api/TransfersHandler.h b/libresapi/src/api/TransfersHandler.h
index 39659d97a..7d07a7198 100644
--- a/libresapi/src/api/TransfersHandler.h
+++ b/libresapi/src/api/TransfersHandler.h
@@ -16,11 +16,15 @@ public:
 	TransfersHandler(StateTokenServer* sts, RsFiles* files, RsPeers *peers, RsNotify& notify);
     virtual ~TransfersHandler();
 
-	// from NotifyClient
-	// may be called from foreign thread
+	/**
+	 Derived from NotifyClient
+	 This function may be called from foreign thread
+	*/
 	virtual void notifyListChange(int list, int type);
+
     // from Tickable
     virtual void tick();
+
 private:
     void handleWildcard(Request& req, Response& resp);
     void handleControlDownload(Request& req, Response& resp);
@@ -32,7 +36,12 @@ private:
 	RsPeers* mRsPeers;
 	RsNotify& mNotify;
 
+	/**
+	 Protects mStateToken that may be changed in foreign thread
+	 @see TransfersHandler::notifyListChange(...)
+	*/
 	RsMutex mMtx;
+
     StateToken mStateToken;
     time_t mLastUpdateTS;