diff --git a/src/Redmine/Api/AbstractApi.php b/src/Redmine/Api/AbstractApi.php index af329ca9..c3b26752 100644 --- a/src/Redmine/Api/AbstractApi.php +++ b/src/Redmine/Api/AbstractApi.php @@ -81,7 +81,7 @@ final public function getLastResponse(): Response * * @return bool * - * @deprecated since v2.1.0, because it does not correctly handle 2xx codes that are not 200 or 201, use `Redmine\Api\AbstractApi::getLastResponse()->getStatusCode()` instead + * @deprecated v2.1.0 It does not correctly handle 2xx codes that are not 200 or 201, use `Redmine\Api\AbstractApi::getLastResponse()->getStatusCode()` instead * @see AbstractApi::getLastResponse()->getStatusCode() for checking the status code directly */ public function lastCallFailed() @@ -102,7 +102,8 @@ public function lastCallFailed() /** * Perform the client get() method. * - * @deprecated since v2.6.0, use `\Redmine\Http\HttpClient::request()` instead + * @deprecated v2.6.0 Use `\Redmine\Http\HttpClient::request()` instead + * @see \Redmine\Http\HttpClient::request() * * @param string $path * @param bool $decodeIfJson @@ -141,7 +142,8 @@ protected function get($path, $decodeIfJson = true) /** * Perform the client post() method. * - * @deprecated since v2.6.0, use `\Redmine\Http\HttpClient::request()` instead + * @deprecated v2.6.0 Use `\Redmine\Http\HttpClient::request()` instead + * @see \Redmine\Http\HttpClient::request() * * @param string $path * @param string $data @@ -247,7 +249,8 @@ protected function sanitizeParams(array $defaults, array $params) * Retrieves all the elements of a given endpoint (even if the * total number of elements is greater than 100). * - * @deprecated since v2.2.0, use `retrieveData()` instead + * @deprecated v2.2.0 Use `retrieveData()` instead + * @see AbstractApi::retrieveData() * * @param string $endpoint API end point * @param array $params optional parameters to be passed to the api (offset, limit, ...) @@ -347,7 +350,8 @@ protected function retrieveData(string $endpoint, array $params = []): array /** * Attaches Custom Fields to a create/update query. * - * @deprecated since v2.3.0, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead + * @deprecated v2.3.0 Use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead + * @see \Redmine\Serializer\XmlSerializer::createFromArray() * * @param SimpleXMLElement $xml XML Element the custom fields are attached to * @param array $fields array of fields to attach, each field needs name, id and value set diff --git a/src/Redmine/Api/CustomField.php b/src/Redmine/Api/CustomField.php index ae81b6d1..90d40313 100644 --- a/src/Redmine/Api/CustomField.php +++ b/src/Redmine/Api/CustomField.php @@ -40,7 +40,8 @@ final public function list(array $params = []): array /** * List custom fields. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see CustomField::list() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_CustomFields#GET * diff --git a/src/Redmine/Api/Group.php b/src/Redmine/Api/Group.php index 442f848b..99224759 100644 --- a/src/Redmine/Api/Group.php +++ b/src/Redmine/Api/Group.php @@ -46,7 +46,8 @@ final public function list(array $params = []): array /** * List groups. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see Group::list() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET * diff --git a/src/Redmine/Api/Issue.php b/src/Redmine/Api/Issue.php index f56a7ea2..8ebe5f93 100644 --- a/src/Redmine/Api/Issue.php +++ b/src/Redmine/Api/Issue.php @@ -86,7 +86,8 @@ final public function list(array $params = []): array /** * List issues. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see Issue::list() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_Issues * available $params : diff --git a/src/Redmine/Api/IssueCategory.php b/src/Redmine/Api/IssueCategory.php index 903aabf3..b8871e88 100644 --- a/src/Redmine/Api/IssueCategory.php +++ b/src/Redmine/Api/IssueCategory.php @@ -56,7 +56,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr /** * List issue categories. * - * @deprecated since v2.4.0, use listByProject() instead. + * @deprecated v2.4.0 Use listByProject() instead. + * @see IssueCategory::listByProject() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#GET * diff --git a/src/Redmine/Api/IssuePriority.php b/src/Redmine/Api/IssuePriority.php index 2a639096..0d08a77f 100644 --- a/src/Redmine/Api/IssuePriority.php +++ b/src/Redmine/Api/IssuePriority.php @@ -40,7 +40,8 @@ final public function list(array $params = []): array /** * List issue priorities. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see IssuePriority::list() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#enumerationsissue_prioritiesformat * diff --git a/src/Redmine/Api/IssueRelation.php b/src/Redmine/Api/IssueRelation.php index 5cb90b96..941d7ea3 100644 --- a/src/Redmine/Api/IssueRelation.php +++ b/src/Redmine/Api/IssueRelation.php @@ -44,7 +44,8 @@ final public function listByIssueId(int $issueId, array $params = []): array /** * List relations of the given issue. * - * @deprecated since v2.4.0, use listByIssueId() instead. + * @deprecated v2.4.0 Use listByIssueId() instead. + * @see IssueRelation::listByIssueId() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#GET * diff --git a/src/Redmine/Api/IssueStatus.php b/src/Redmine/Api/IssueStatus.php index 07e39924..a7c076a1 100644 --- a/src/Redmine/Api/IssueStatus.php +++ b/src/Redmine/Api/IssueStatus.php @@ -40,7 +40,8 @@ final public function list(array $params = []): array /** * List issue statuses. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see IssueStatus::list() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_IssueStatuses#GET * diff --git a/src/Redmine/Api/Membership.php b/src/Redmine/Api/Membership.php index 583be03c..69e7b9a3 100644 --- a/src/Redmine/Api/Membership.php +++ b/src/Redmine/Api/Membership.php @@ -54,7 +54,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr /** * List memberships for a given $project. * - * @deprecated since v2.4.0, use listByProject() instead. + * @deprecated v2.4.0 Use listByProject() instead. + * @see Membership::listByProject() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_Memberships#GET * diff --git a/src/Redmine/Api/News.php b/src/Redmine/Api/News.php index e81f1ccb..d6b30419 100644 --- a/src/Redmine/Api/News.php +++ b/src/Redmine/Api/News.php @@ -68,7 +68,9 @@ final public function list(array $params = []): array /** * List news (if no $project is given, it will return ALL the news). * - * @deprecated since v2.4.0, use list() or listByProject() instead. + * @deprecated v2.4.0 Use list() or listByProject() instead. + * @see News::list() + * @see News::listByProject() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_News#GET * diff --git a/src/Redmine/Api/Project.php b/src/Redmine/Api/Project.php index 9daa6d6c..346406ec 100755 --- a/src/Redmine/Api/Project.php +++ b/src/Redmine/Api/Project.php @@ -47,7 +47,8 @@ final public function list(array $params = []): array /** * List projects. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see Project::list() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_Projects * @@ -361,7 +362,8 @@ final public function unarchive($projectIdentifier): bool } /** - * @deprecated since v2.3.0, use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead. + * @deprecated v2.3.0 Use `\Redmine\Serializer\XmlSerializer::createFromArray()` instead. + * @see \Redmine\Serializer\XmlSerializer::createFromArray() * * @param array $params * diff --git a/src/Redmine/Api/Query.php b/src/Redmine/Api/Query.php index 85b52d3c..4db772fc 100644 --- a/src/Redmine/Api/Query.php +++ b/src/Redmine/Api/Query.php @@ -40,7 +40,8 @@ final public function list(array $params = []): array /** * Returns the list of all custom queries visible by the user (public and private queries) for all projects. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see Query::list() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_Queries#GET * diff --git a/src/Redmine/Api/Role.php b/src/Redmine/Api/Role.php index dc0dc85d..668b0bb7 100644 --- a/src/Redmine/Api/Role.php +++ b/src/Redmine/Api/Role.php @@ -42,7 +42,8 @@ final public function list(array $params = []): array /** * List roles. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see Role::list() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_Roles#GET * diff --git a/src/Redmine/Api/Search.php b/src/Redmine/Api/Search.php index efbfeedc..ff823952 100644 --- a/src/Redmine/Api/Search.php +++ b/src/Redmine/Api/Search.php @@ -39,7 +39,8 @@ final public function listByQuery(string $query, array $params = []): array /** * Search. * - * @deprecated since v2.4.0, use listByQuery() instead. + * @deprecated v2.4.0 Use listByQuery() instead. + * @see Search::listByQuery() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_Search * diff --git a/src/Redmine/Api/TimeEntry.php b/src/Redmine/Api/TimeEntry.php index 5aa63c85..eee06cd7 100644 --- a/src/Redmine/Api/TimeEntry.php +++ b/src/Redmine/Api/TimeEntry.php @@ -45,7 +45,8 @@ final public function list(array $params = []): array /** * List time entries. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see TimeEntry::list() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_TimeEntries * diff --git a/src/Redmine/Api/TimeEntryActivity.php b/src/Redmine/Api/TimeEntryActivity.php index ed496348..71e623da 100644 --- a/src/Redmine/Api/TimeEntryActivity.php +++ b/src/Redmine/Api/TimeEntryActivity.php @@ -38,7 +38,8 @@ final public function list(array $params = []): array /** * List time entry activities. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see TimeEntryActivity::list() * * @param array $params optional parameters to be passed to the api (offset, limit, ...) * diff --git a/src/Redmine/Api/Tracker.php b/src/Redmine/Api/Tracker.php index 60df6a03..107c090c 100644 --- a/src/Redmine/Api/Tracker.php +++ b/src/Redmine/Api/Tracker.php @@ -40,7 +40,8 @@ final public function list(array $params = []): array /** * List trackers. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see Tracker::list() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_Trackers#GET * diff --git a/src/Redmine/Api/User.php b/src/Redmine/Api/User.php index b6ea1aad..6e8318b1 100644 --- a/src/Redmine/Api/User.php +++ b/src/Redmine/Api/User.php @@ -46,7 +46,8 @@ final public function list(array $params = []): array /** * List users. * - * @deprecated since v2.4.0, use list() instead. + * @deprecated v2.4.0 Use list() instead. + * @see User::list() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_Users#GET * diff --git a/src/Redmine/Api/Version.php b/src/Redmine/Api/Version.php index 4fd8faba..57717dd5 100644 --- a/src/Redmine/Api/Version.php +++ b/src/Redmine/Api/Version.php @@ -54,7 +54,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr /** * List versions. * - * @deprecated since v2.4.0, use listByProject() instead. + * @deprecated v2.4.0 Use listByProject() instead. + * @see Version::listByProject() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_Versions#GET * diff --git a/src/Redmine/Api/Wiki.php b/src/Redmine/Api/Wiki.php index bac49c32..af7a9c36 100644 --- a/src/Redmine/Api/Wiki.php +++ b/src/Redmine/Api/Wiki.php @@ -53,7 +53,8 @@ final public function listByProject($projectIdentifier, array $params = []): arr /** * List wiki pages of given $project. * - * @deprecated since v2.4.0, use listByProject() instead. + * @deprecated v2.4.0 Use listByProject() instead. + * @see Wiki::listByProject() * * @see http://www.redmine.org/projects/redmine/wiki/Rest_WikiPages#Getting-the-pages-list-of-a-wiki *