Merge pull request #37 from 21TORR/mark-dep

apfelbox · web-flow · commit fb55178d7b65 · 2024-03-13T13:37:14.000+01:00
Mark method as deprecated in PHPDoc as well
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+3.1.1
+=====
+
+* (improvement) Mark method as deprecated in PHPDoc as well.
+
+
 3.1.0
 =====
 
diff --git a/src/Api/ApiResponse.php b/src/Api/ApiResponse.php
@@ -29,6 +29,8 @@ public function __construct (
 
 	/**
 	 * @return $this
+	 *
+	 * @deprecated Calling ApiResponse::withStatusCode() is deprecated, pass the status code in the constructor instead.
 	 */
 	public function withStatusCode (int $statusCode) : self
 	{

-Original file line number
+Diff line change
@@ @@ -1,3 +1,9 @@ @@
 +3.1.1
 +=====
++
 +* (improvement) Mark method as deprecated in PHPDoc as well.
++
++
 .1.0
 =====
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ public function __construct (`
`29`	`29`
`30`	`30`	`/**`
`31`	`31`	`* @return $this`
	`32`	`+ *`
	`33`	`+ * @deprecated Calling ApiResponse::withStatusCode() is deprecated, pass the status code in the constructor instead.`
`32`	`34`	`*/`
`33`	`35`	`public function withStatusCode (int $statusCode) : self`
`34`	`36`	`{`