diff options
| -rw-r--r-- | lib/private/Comments/Manager.php | 18 | ||||
| -rw-r--r-- | lib/public/Comments/ICommentsManager.php | 13 |
2 files changed, 17 insertions, 14 deletions
diff --git a/lib/private/Comments/Manager.php b/lib/private/Comments/Manager.php index 37b5f033097..9393cce334d 100644 --- a/lib/private/Comments/Manager.php +++ b/lib/private/Comments/Manager.php @@ -377,11 +377,13 @@ class Manager implements ICommentsManager { } /** - * @param string $objectType - * @param string $objectId - * @param int $lastKnownCommentId - * @param string $sortDirection - * @param int $limit + * @param string $objectType the object type, e.g. 'files' + * @param string $objectId the id of the object + * @param int $lastKnownCommentId the last known comment (will be used as offset) + * @param string $sortDirection direction of the comments (`asc` or `desc`) + * @param int $limit optional, number of maximum comments to be returned. if + * set to 0, all comments are returned. + * @return IComment[] * @return array */ public function getForObjectSince( @@ -463,9 +465,9 @@ class Manager implements ICommentsManager { } /** - * @param string $objectType - * @param string $objectId - * @param int $id + * @param string $objectType the object type, e.g. 'files' + * @param string $objectId the id of the object + * @param int $id the comment to look for * @return Comment|null */ protected function getLastKnownComment(string $objectType, diff --git a/lib/public/Comments/ICommentsManager.php b/lib/public/Comments/ICommentsManager.php index 888e7df3e7f..b3ed176b3b5 100644 --- a/lib/public/Comments/ICommentsManager.php +++ b/lib/public/Comments/ICommentsManager.php @@ -121,12 +121,13 @@ interface ICommentsManager { ); /** - * @param string $objectType - * @param string $objectId - * @param int $lastKnownCommentId - * @param string $sortDirection - * @param int $limit - * @return array + * @param string $objectType the object type, e.g. 'files' + * @param string $objectId the id of the object + * @param int $lastKnownCommentId the last known comment (will be used as offset) + * @param string $sortDirection direction of the comments (`asc` or `desc`) + * @param int $limit optional, number of maximum comments to be returned. if + * set to 0, all comments are returned. + * @return IComment[] * @since 14.0.0 */ public function getForObjectSince( |