From 3a1f1eced05f5f7ca3244f009e111eed2e809119 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Wed, 13 Dec 2017 16:29:02 +0900 Subject: EventsBatch: document the class --- events/event.h | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/events/event.h b/events/event.h index fa8a58af..bd33bb50 100644 --- a/events/event.h +++ b/events/event.h @@ -83,10 +83,33 @@ namespace QMatrixClient }; using EventType = Event::Type; + /** + * \brief A vector of pointers to events with deserialisation capabilities + * + * This is a simple wrapper over a generic vector type that adds + * a convenience method to deserialise events from QJsonArray. + * Note that this type does not own pointers to events. If owning + * semantics is needed, one should use the Owning<> wrapper around + * the container (e.g. \code Owning> \endcode). + * \tparam EventT base type of all events in the vector + */ template class EventsBatch : public std::vector { public: + /** + * \brief Deserialise events from an array + * + * Given the following JSON construct, creates events from + * the array stored at key "node": + * \code + * "container": { + * "node": [ { "event_id": "!evt1:srv.org", ... }, ... ] + * } + * \endcode + * \param container - the wrapping JSON object + * \param node - the key in container that holds the array of events + */ void fromJson(const QJsonObject& container, const QString& node) { const auto objs = container.value(node).toArray(); -- cgit v1.2.3