diff options
Diffstat (limited to 'lib/public/Comments/ICommentsManager.php')
| -rw-r--r-- | lib/public/Comments/ICommentsManager.php | 13 |
1 files changed, 7 insertions, 6 deletions
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( |