aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/read_markers.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/read_markers.h')
-rw-r--r--lib/csapi/read_markers.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/csapi/read_markers.h b/lib/csapi/read_markers.h
index 539aa5e4..addb9123 100644
--- a/lib/csapi/read_markers.h
+++ b/lib/csapi/read_markers.h
@@ -8,8 +8,6 @@
namespace Quotient {
-// Operations
-
/*! \brief Set the position of the read marker for a room.
*
* Sets the position of the read marker for a given room, and optionally
@@ -19,11 +17,14 @@ class SetReadMarkerJob : public BaseJob {
public:
/*! \brief Set the position of the read marker for a room.
*
+ *
* \param roomId
* The room ID to set the read marker in for the user.
+ *
* \param mFullyRead
* The event ID the read marker should be located at. The
* event MUST belong to the room.
+ *
* \param mRead
* The event ID to set the read receipt location at. This is
* equivalent to calling ``/receipt/m.read/$elsewhere:example.org``