Improve typing in ICommentsManager

Signed-off-by: Carl Schwan <carl@carlschwan.eu>
Signed-off-by: dartcafe <github@dartcafe.de>
This commit is contained in:
Carl Schwan 2022-11-28 10:54:47 +01:00 committed by dartcafe
parent 8f94fd0102
commit 854836c56a
No known key found for this signature in database
GPG key ID: CCE73CEF3035D3C8

View 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