]> source.dussan.org Git - nextcloud-server.git/commitdiff
Improve typing in ICommentsManager
authorCarl Schwan <carl@carlschwan.eu>
Mon, 28 Nov 2022 09:54:47 +0000 (10:54 +0100)
committerCôme Chilliet <come.chilliet@nextcloud.com>
Tue, 20 Jun 2023 08:55:26 +0000 (10:55 +0200)
Signed-off-by: Carl Schwan <carl@carlschwan.eu>
lib/public/Comments/ICommentsManager.php

index d3f78b4f2e3702cec3ba651b44d46feaf1c10931..8d7ffd164b3af958d0f4598ca9d102b9d29db9c2 100644 (file)
@@ -36,9 +36,6 @@ use OCP\PreConditionNotMetException;
  *
  * 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