From: Carl Hetherington <cth@carlh.net>
Date: Thu, 27 Jul 2017 10:06:25 +0000 (+0100)
Subject: Add comment.
X-Git-Tag: v2.11.15~12
X-Git-Url: https://main.carlh.net/gitweb/?a=commitdiff_plain;h=d79b3415d397dd81d21263c2cc35b77dca1e7997;p=dcpomatic.git

Add comment.
---

diff --git a/src/lib/encode_server_finder.h b/src/lib/encode_server_finder.h
index c639dfe3b..da610bd54 100644
--- a/src/lib/encode_server_finder.h
+++ b/src/lib/encode_server_finder.h
@@ -31,6 +31,15 @@
 
 class Socket;
 
+/** @class EncodeServerFinder
+ *  @brief Locater of encoding servers.
+ *
+ *  This class finds active (i.e. responding) encode servers.  Depending on
+ *  configuration it finds servers by:
+ *
+ *  1. broadcasting a request to the local subnet and
+ *  2. checking to see if any of the configured server hosts are up.
+ */
 class EncodeServerFinder : public Signaller, public ExceptionStore
 {
 public: