Document pollhandler

src/pollhandler.h

@@ -9,15 +9,49 @@
 
 class NeoChatRoom;
 
+/**
+ * @class PollHandler
+ *
+ * A class to help manage a poll in a room.
+ *
+ * A poll is made up of a start event that poses the question and possible answers,
+ * and is followed by a series of response events as users in the room select
+ * their choice. This purpose of the poll handler is to keep track of all this as
+ * the poll is displayed as a single event in the timeline which merges all this
+ * information.
+ */
 class PollHandler : public QObject
 {
     Q_OBJECT
 
+    /**
+     * @brief The current room for the poll.
+     */
     Q_PROPERTY(NeoChatRoom *room READ room WRITE setRoom NOTIFY roomChanged)
+
+    /**
+     * @brief The Matrix event ID for the event that started the poll.
+     */
     Q_PROPERTY(QString pollStartEventId READ pollStartEventId WRITE setPollStartEventId NOTIFY pollStartEventIdChanged)
+
+    /**
+     * @brief The list of answers to the poll from users in the room.
+     */
     Q_PROPERTY(QJsonObject answers READ answers NOTIFY answersChanged)
+
+    /**
+     * @brief The list number of votes for each answer in the poll.
+     */
     Q_PROPERTY(QJsonObject counts READ counts NOTIFY answersChanged)
+
+    /**
+     * @brief Whether the poll has ended.
+     */
     Q_PROPERTY(bool hasEnded READ hasEnded NOTIFY hasEndedChanged)
+
+    /**
+     * @brief The total number of answers to the poll.
+     */
     Q_PROPERTY(int answerCount READ answerCount NOTIFY answersChanged)
 
 public:
@@ -32,10 +66,12 @@ public:
     bool hasEnded() const;
     int answerCount() const;
 
-    void checkLoadRelations();
-
     QJsonObject answers() const;
     QJsonObject counts() const;
+
+    /**
+     * @brief Send an answer to the poll.
+     */
     Q_INVOKABLE void sendPollAnswer(const QString &eventId, const QString &answerId);
 
 Q_SIGNALS:
@@ -48,6 +84,7 @@ private:
     NeoChatRoom *m_room = nullptr;
     QString m_pollStartEventId;
 
+    void checkLoadRelations();
     void handleAnswer(const QJsonObject &object, const QString &sender, QDateTime timestamp);
     QMap<QString, QDateTime> m_answerTimestamps;
     QJsonObject m_answers;