Adjust Doxyfile, document Advertiser

The Doxyfile now correctly reports the version as "0.0.1", and private
and static members are also now extracted, if only to make the
documentation fuller.

The README.md file is used as the index page for the generated Doxygen
documentation.

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "Akashi"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "0.0.0"
+PROJECT_NUMBER         = "0.0.1"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
@@ -473,7 +473,7 @@ EXTRACT_ALL            = NO
 # be included in the documentation.
 # The default value is: NO.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
 # methods of a class will be included in the documentation.
@@ -491,7 +491,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,
@@ -830,7 +830,8 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = src/ \
-                         include/
+                         include/ \
+                         README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1027,7 +1028,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

include/advertiser.h

@@ -25,31 +25,106 @@
 #include <QString>
 #include <QTcpSocket>
 
+/**
+ * @brief A communicator class to update the master server on the server's status.
+ */
 class Advertiser : public QObject {
     Q_OBJECT
 
   public:
-    Advertiser(QString p_ip, int p_port, int p_ws_port, int p_local_port,
+    /**
-               QString p_name, QString p_description,
+     * @brief Constructor for the Advertiser class.
-               QObject* parent = nullptr);
+     *
+     * @param p_ip The IP of the master server.
+     * @param p_port The port on which the connection to the master server should be established.
+     * @param p_ws_port The port on which the server will accept connections from clients through WebSocket.
+     * @param p_local_port The port on which the server will accept connections from clients through TCP.
+     * @param p_name The name of the server, as reported in the client's server browser.
+     * @param p_description The description of the server, as reported in the client's server browser.
+     * @param p_parent Qt-based parent, passed along to inherited constructor from QObject.
+     */
+    Advertiser(const QString p_ip, const int p_port, const int p_ws_port, const int p_local_port,
+               const QString p_name, const QString p_description, QObject* p_parent = nullptr) :
+        QObject(p_parent),
+        ip(p_ip),
+        port(p_port),
+        ws_port(p_ws_port),
+        local_port(p_local_port),
+        name(p_name),
+        description(p_description)
+    {};
+
+    /**
+     * @brief Destructor for the Advertiser class.
+     *
+     * @details Marks the socket used to establish connection to the master server to be deleted later.
+     */
     ~Advertiser();
+
+    /**
+     * @brief Sets up the socket used for master server connection, establishes connection to the master server.
+     */
     void contactMasterServer();
 
-signals:
-
   public slots:
+    /**
+     * @brief Handles data that was read from the master server's socket.
+     *
+     * @note Currently does nothing.
+     */
     void readData();
+
+    /**
+     * @brief Announces the server's presence to the master server.
+     */
     void socketConnected();
+
+    /**
+     * @brief Handles disconnection from the master server through the socket.
+     *
+     * @note Currently does nothing but outputs a line about the disconnection in the debug output.
+     */
     void socketDisconnected();
 
   private:
+    /**
+     * @copydoc ConfigManager::server_settings::ms_ip
+     */
     QString ip;
+
+    /**
+     * @copydoc ConfigManager::server_settings::port
+     *
+     * @bug Because of a typo in the code, this also replaces #local_port, thus clients will have to attempt
+     * to connect through the same port as the connection is established to the master server.
+     */
     int port;
+
+    /**
+     * @copydoc ConfigManager::server_settings::ws_port
+     */
     int ws_port;
+
+    /**
+     * @copydoc ConfigManager::server_settings::local_port
+     *
+     * @bug See #port.
+     */
     int local_port;
+
+    /**
+     * @copydoc ConfigManager::server_settings::name
+     */
     QString name;
+
+    /**
+     * @copydoc ConfigManager::server_settings::description
+     */
     QString description;
 
+    /**
+     * @brief The socket used to establish connection to the master server.
+     */
     QTcpSocket* socket;
 };
 

src/advertiser.cpp

@@ -17,19 +17,6 @@
 //////////////////////////////////////////////////////////////////////////////////////
 #include "include/advertiser.h"
 
-Advertiser::Advertiser(QString p_ip, int p_port, int p_ws_port,
-                       int p_local_port, QString p_name, QString p_description,
-                       QObject* parent)
-    : QObject(parent)
-{
-    ip = p_ip;
-    port = p_port;
-    ws_port = p_ws_port;
-    local_port = p_local_port;
-    name = p_name;
-    description = p_description;
-}
-
 void Advertiser::contactMasterServer()
 {
     socket = new QTcpSocket(this);