Improves description of RPC endpoints

BurntimeX · BurntimeX · commit b918af97c41d · 2025-08-01T17:04:11.000+02:00
diff --git a/files/lib/system/endpoint/controller/core/conversations/CloseConversation.class.php b/files/lib/system/endpoint/controller/core/conversations/CloseConversation.class.php
@@ -15,7 +15,7 @@
 use wcf\system\WCF;
 
 /**
- * API endpoint for close a conversation for new messages.
+ * Closes the conversation with the given ID for new messages.
  *
  * @author Olaf Braun
  * @copyright 2001-2025 WoltLab GmbH
diff --git a/files/lib/system/endpoint/controller/core/conversations/GetConversationHeaderTitle.class.php b/files/lib/system/endpoint/controller/core/conversations/GetConversationHeaderTitle.class.php
@@ -14,7 +14,7 @@
 use wcf\system\WCF;
 
 /**
- * API endpoint for the rendering of the conversation content header title.
+ * Retrieves the HTML code for the content header title of the conversation with the given ID.
  *
  * @author Olaf Braun
  * @copyright 2001-2025 WoltLab GmbH
diff --git a/files/lib/system/endpoint/controller/core/conversations/GetConversationParticipantList.class.php b/files/lib/system/endpoint/controller/core/conversations/GetConversationParticipantList.class.php
@@ -14,7 +14,7 @@
 use wcf\system\WCF;
 
 /**
- * API endpoint for retrieving the participant list of a conversation.
+ * Retrieves the HTML code for the list of participants of the conversation with the given ID.
  *
  * @author Olaf Braun
  * @copyright 2001-2025 WoltLab GmbH
diff --git a/files/lib/system/endpoint/controller/core/conversations/GetConversationPopover.class.php b/files/lib/system/endpoint/controller/core/conversations/GetConversationPopover.class.php
@@ -14,7 +14,7 @@
 use wcf\system\WCF;
 
 /**
- * API endpoint for the rendering of the conversation popover.
+ * Retrieves the HTML code for the popover of the conversation with the given ID.
  *
  * @author      Marcel Werk
  * @copyright   2001-2025 WoltLab GmbH
diff --git a/files/lib/system/endpoint/controller/core/conversations/LeaveConversation.class.php b/files/lib/system/endpoint/controller/core/conversations/LeaveConversation.class.php
@@ -12,7 +12,7 @@
 use wcf\system\exception\PermissionDeniedException;
 
 /**
- * API endpoint for leaving a conversation.
+ * Leaves the conversation with the given ID.
  *
  * @author      Olaf Braun
  * @copyright   2001-2025 WoltLab GmbH
diff --git a/files/lib/system/endpoint/controller/core/conversations/LeavePermanentlyConversation.class.php b/files/lib/system/endpoint/controller/core/conversations/LeavePermanentlyConversation.class.php
@@ -12,7 +12,7 @@
 use wcf\system\exception\PermissionDeniedException;
 
 /**
- * API endpoint for leaving a conversation permanently.
+ * Leaves the conversation with the given ID permanently.
  *
  * @author Olaf Braun
  * @copyright 2001-2025 WoltLab GmbH
diff --git a/files/lib/system/endpoint/controller/core/conversations/OpenConversation.class.php b/files/lib/system/endpoint/controller/core/conversations/OpenConversation.class.php
@@ -15,7 +15,7 @@
 use wcf\system\WCF;
 
 /**
- * API endpoint for open a conversation for new messages.
+ * Opens the conversation with the given ID for new messages.
  *
  * @author Olaf Braun
  * @copyright 2001-2025 WoltLab GmbH
diff --git a/files/lib/system/endpoint/controller/core/conversations/RemoveConversationParticipant.class.php b/files/lib/system/endpoint/controller/core/conversations/RemoveConversationParticipant.class.php
@@ -15,7 +15,7 @@
 use wcf\system\WCF;
 
 /**
- * API endpoint for removing a participant from a conversation.
+ * Removes a participant from the conversation with the given ID.
  *
  * @author Olaf Braun
  * @copyright 2001-2025 WoltLab GmbH
diff --git a/files/lib/system/endpoint/controller/core/conversations/RestoreConversation.class.php b/files/lib/system/endpoint/controller/core/conversations/RestoreConversation.class.php
@@ -12,7 +12,7 @@
 use wcf\system\exception\PermissionDeniedException;
 
 /**
- * API endpoint for restore a conversation.
+ * Restores the conversation with the given ID.
  *
  * @author Olaf Braun
  * @copyright 2001-2025 WoltLab GmbH
diff --git a/files/lib/system/endpoint/controller/core/conversations/labels/DeleteConversationLabel.class.php b/files/lib/system/endpoint/controller/core/conversations/labels/DeleteConversationLabel.class.php
@@ -14,7 +14,7 @@
 use wcf\system\WCF;
 
 /**
- * API endpoint for delete a conversation label.
+ * Deletes the conversation label with the given ID.
  *
  * @author Olaf Braun
  * @copyright 2001-2025 WoltLab GmbH

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`use wcf\system\WCF;`
`16`	`16`
`17`	`17`	`/**`
`18`		`- * API endpoint for close a conversation for new messages.`
	`18`	`+ * Closes the conversation with the given ID for new messages.`
`19`	`19`	`*`
`20`	`20`	`* @author Olaf Braun`
`21`	`21`	`* @copyright 2001-2025 WoltLab GmbH`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`use wcf\system\WCF;`
`15`	`15`
`16`	`16`	`/**`
`17`		`- * API endpoint for the rendering of the conversation content header title.`
	`17`	`+ * Retrieves the HTML code for the content header title of the conversation with the given ID.`
`18`	`18`	`*`
`19`	`19`	`* @author Olaf Braun`
`20`	`20`	`* @copyright 2001-2025 WoltLab GmbH`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`use wcf\system\exception\PermissionDeniedException;`
`13`	`13`
`14`	`14`	`/**`
`15`		`- * API endpoint for leaving a conversation.`
	`15`	`+ * Leaves the conversation with the given ID.`
`16`	`16`	`*`
`17`	`17`	`* @author Olaf Braun`
`18`	`18`	`* @copyright 2001-2025 WoltLab GmbH`