aboutsummaryrefslogtreecommitdiff
path: root/lib/room.h
diff options
context:
space:
mode:
authorAlexey Rusakov <Kitsune-Ral@users.sf.net>2021-10-18 05:42:12 +0200
committerAlexey Rusakov <Kitsune-Ral@users.sf.net>2021-11-17 18:33:56 +0100
commit7b633ba257fc8643ef8cc2ef724f3b6ac9e186ba (patch)
treee5ffce0d5f27cf4526e5ebf2dd73e3d89cd3df9c /lib/room.h
parentedb63528e6f3048045f70eb6a48412917bdbea0b (diff)
downloadlibquotient-7b633ba257fc8643ef8cc2ef724f3b6ac9e186ba.tar.gz
libquotient-7b633ba257fc8643ef8cc2ef724f3b6ac9e186ba.zip
Room: doc-comments cleanup
[skip ci]
Diffstat (limited to 'lib/room.h')
-rw-r--r--lib/room.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/room.h b/lib/room.h
index e4d33c4e..24025a88 100644
--- a/lib/room.h
+++ b/lib/room.h
@@ -381,8 +381,8 @@ public:
void setLastDisplayedEvent(TimelineItem::index_t index);
//! \brief Obtain a read receipt of any user
+ //! \deprecated Use lastReadReceipt or fullyReadMarker instead.
//!
- //! \deprecated Use lastReadReceipt or fullyReadMarker instead
//! Historically, readMarker was returning a "converged" read marker
//! representing both the read receipt and the fully read marker, as
//! Quotient managed them together. Since 0.6.8, a single-argument call of
@@ -397,16 +397,19 @@ public:
rev_iter_t readMarker(const User* user) const;
//! \brief Obtain the local user's fully-read marker
//! \deprecated Use fullyReadMarker instead
- //! See the documentation for the single-argument overload
+ //!
+ //! See the documentation for the single-argument overload.
//! \sa fullyReadMarker
[[deprecated("Use lastReadReceipt() to get m.read receipt or"
" fullyReadMarker() to get m.fully_read marker")]] //
rev_iter_t readMarker() const;
//! \brief Get the event id for the local user's fully-read marker
//! \deprecated Use lastFullyReadEventId instead
+ //!
//! See the readMarker documentation
[[deprecated("Use lastReadReceipt() to get m.read receipt or"
- " fullyReadMarker() to get m.fully_read marker")]] //
+ " lastFullyReadEventId() to get an event id that"
+ " m.fully_read marker points to")]] //
QString readMarkerEventId() const;
//! \brief Get the latest read receipt from a user