room.h: Unify doc-comments

Doxygen/Qt style is preferred from now on.

1 files changed, 17 insertions, 17 deletions

diff --git a/lib/room.h b/lib/room.h
index 08ea3256..9b909a98 100644
--- a/lib/room.h
+++ b/lib/room.h
@@ -129,20 +129,20 @@ namespace QMatrixClient
             /**
              * Returns a square room avatar with the given size and requests it
              * from the network if needed
-             * @return a pixmap with the avatar or a placeholder if there's none
+             * \return a pixmap with the avatar or a placeholder if there's none
              * available yet
              */
             Q_INVOKABLE QImage avatar(int dimension);
             /**
              * Returns a room avatar with the given dimensions and requests it
              * from the network if needed
-             * @return a pixmap with the avatar or a placeholder if there's none
+             * \return a pixmap with the avatar or a placeholder if there's none
              * available yet
              */
             Q_INVOKABLE QImage avatar(int width, int height);
 
             /**
-             * @brief Get a user object for a given user id
+             * \brief Get a user object for a given user id
              * This is the recommended way to get a user object in a room
              * context. The actual object type may be changed in further
              * versions to provide room-specific user information (display name,
@@ -164,12 +164,12 @@ namespace QMatrixClient
             Q_INVOKABLE JoinState memberJoinState(User* user) const;
 
             /**
-             * @brief Produces a disambiguated name for a given user in
+             * Get a disambiguated name for a given user in
              * the context of the room
              */
             Q_INVOKABLE QString roomMembername(const User* u) const;
             /**
-             * @brief Produces a disambiguated name for a user with this id in
+             * Get a disambiguated name for a user with this id in
              * the context of the room
              */
             Q_INVOKABLE QString roomMembername(const QString& userId) const;
@@ -177,8 +177,8 @@ namespace QMatrixClient
             const Timeline& messageEvents() const;
             const PendingEvents& pendingEvents() const;
             /**
-             * A convenience method returning the read marker to the before-oldest
-             * message
+             * A convenience method returning the read marker to
+             * the before-oldest message
              */
             rev_iter_t timelineEdge() const;
             Q_INVOKABLE TimelineItem::index_t minTimelineIndex() const;
@@ -203,7 +203,7 @@ namespace QMatrixClient
             rev_iter_t readMarker() const;
             QString readMarkerEventId() const;
             /**
-             * @brief Mark the event with uptoEventId as read
+             * \brief Mark the event with uptoEventId as read
              *
              * Finds in the timeline and marks as read the event with
              * the specified id; also posts a read receipt to the server either
@@ -212,7 +212,7 @@ namespace QMatrixClient
              */
             void markMessagesAsRead(QString uptoEventId);
 
-            /** Check whether there are unread messages in the room */
+            /// Check whether there are unread messages in the room
             bool hasUnreadMessages() const;
 
             /** Get the number of unread messages in the room
@@ -263,7 +263,7 @@ namespace QMatrixClient
             void addTag(const QString& name, const TagRecord& record = {});
             Q_INVOKABLE void addTag(const QString& name, const QString& order);
 
-            /** Remove a tag from the room */
+            /// Remove a tag from the room
             Q_INVOKABLE void removeTag(const QString& name);
 
             /** Overwrite the room's tags
@@ -276,15 +276,15 @@ namespace QMatrixClient
              */
             void setTags(TagsMap newTags);
 
-            /** Check whether the list of tags has m.favourite */
+            /// Check whether the list of tags has m.favourite
             bool isFavourite() const;
-            /** Check whether the list of tags has m.lowpriority */
+            /// Check whether the list of tags has m.lowpriority
             bool isLowPriority() const;
 
-            /** Check whether this room is a direct chat */
+            /// Check whether this room is a direct chat
             Q_INVOKABLE bool isDirectChat() const;
 
-            /** Get the list of users this room is a direct chat with */
+            /// Get the list of users this room is a direct chat with
             QList<User*> directChatUsers() const;
 
             Q_INVOKABLE QUrl urlToThumbnail(const QString& eventId);
@@ -340,7 +340,7 @@ namespace QMatrixClient
                               const QUrl& localFilename = {});
             void cancelFileTransfer(const QString& id);
 
-            /** Mark all messages in the room as read */
+            /// Mark all messages in the room as read
             void markAllMessagesAsRead();
 
         signals:
@@ -357,12 +357,12 @@ namespace QMatrixClient
             void pendingEventChanged(int pendingEventIndex);
 
             /**
-             * @brief The room name, the canonical alias or other aliases changed
+             * \brief The room name, the canonical alias or other aliases changed
              *
              * Not triggered when displayname changes.
              */
             void namesChanged(Room* room);
-            /** @brief The room displayname changed */
+            /// The room displayname changed
             void displaynameChanged(Room* room, QString oldName);
             void topicChanged();
             void avatarChanged();