Update author documentation now we've moved to RoomMember

This commit is contained in:
James Graham
2024-06-30 17:58:46 +01:00
parent c8d5d095e0
commit 068161719e
2 changed files with 4 additions and 22 deletions

View File

@@ -15,18 +15,9 @@ RowLayout {
/**
* @brief The message author.
*
* This should consist of the following:
* - id - The matrix ID of the author.
* - isLocalUser - Whether the author is the local user.
* - avatarSource - The mxc URL for the author's avatar in the current room.
* - avatarMediaId - The media ID of the author's avatar.
* - avatarUrl - The mxc URL for the author's avatar.
* - displayName - The display name of the author.
* - display - The name of the author.
* - color - The color for the author.
* - object - The Quotient::User object for the author.
* A Quotient::RoomMember object.
*
* @sa Quotient::User
* @sa Quotient::RoomMember
*/
required property var author

View File

@@ -14,18 +14,9 @@ RowLayout {
/**
* @brief The message author.
*
* This should consist of the following:
* - id - The matrix ID of the author.
* - isLocalUser - Whether the author is the local user.
* - avatarSource - The mxc URL for the author's avatar in the current room.
* - avatarMediaId - The media ID of the author's avatar.
* - avatarUrl - The mxc URL for the author's avatar.
* - displayName - The display name of the author.
* - display - The name of the author.
* - color - The color for the author.
* - object - The Quotient::User object for the author.
* A Quotient::RoomMember object.
*
* @sa Quotient::User
* @sa Quotient::RoomMember
*/
required property var author