Improve typing in ICommentsManager

Signed-off-by: Carl Schwan <carl@carlschwan.eu>
nextcloud · May 25, 2023 · 7ccf065 · 7ccf065
1 parent e7a6f51
commit 7ccf065
Showing 1 changed file with 2 additions and 4 deletions.
diff --git a/lib/public/Comments/ICommentsManager.php b/lib/public/Comments/ICommentsManager.php
@@ -36,9 +36,6 @@
  *
  * This class manages the access to comments
  *
- * @psalm-type CommentNode = array{comment: IComment, replies: list<CommentNode>}
- * @psalm-type CommentTree = list<CommentNode>
- *
  * @since 9.0.0
  */
 interface ICommentsManager {
@@ -64,11 +61,12 @@ interface ICommentsManager {
 	public function get($id);
 
 	/**
-	 * returns the comment specified by the id and all it's child comments
+	 * Returns the comment specified by the id and all it's child comments
 	 *
 	 * @param string $id
 	 * @param int $limit max number of entries to return, 0 returns all
 	 * @param int $offset the start entry
+	 * @return array{comment: IComment, replies: list<array{comment: IComment, replies: array<empty, empty>}>}
 	 * @since 9.0.0
 	 *
 	 * The return array looks like this