lode / jsonapi

src/ErrorsDocument.php

Doc Comments +1 added lines, -1 removed lines

@@ -150,7 +150,7 @@
 	/**
 	 * @internal
 	 * 
-	 * @param  string|int $httpStatusCode
+	 * @param  integer $httpStatusCode
 	 * @return int
 	 */
 	protected function determineHttpStatusCode($httpStatusCode) {

src/helpers/ProfileAliasManager.php

Doc Comments +3 added lines

@@ -48,6 +48,8 @@ 
 	
 	/**
 	 * @inheritDoc
+	 * @param string $keyword
+	 * @return string
 	 */
 	public function getKeyword($keyword) {
 		if (isset($this->keywordMapping[$keyword]) === false) {
@@ -64,6 +66,7 @@ 
 	
 	/**
 	 * @inheritDoc
+	 * @return string
 	 */
 	abstract public function getOfficialLink();
 	

src/helpers/Validator.php

Doc Comments +2 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
 	 * 
 	 * @see https://jsonapi.org/format/1.1/#document-resource-object-fields
 	 * 
-	 * @param  string[] $fieldName
+	 * @param  string[] $fieldNames
 	 * @param  string   $objectContainer one of the Validator::OBJECT_CONTAINER_* constants
 	 * @param  array    $options         optional {@see Validator::$defaults}
 	 * 
@@ -64,7 +64,7 @@ 
 	}
 	
 	/**
-	 * @param string $objectContainer one of the Validator::OBJECT_CONTAINER_* constants
+	 * @param string $objectContainerToClear one of the Validator::OBJECT_CONTAINER_* constants
 	 */
 	public function clearUsedFields($objectContainerToClear) {
 		foreach ($this->usedFields as $fieldName => $containerFound) {

src/interfaces/DocumentInterface.php

Doc Comments +1 added lines

@@ -28,6 +28,7 @@
 	 * @note will set http status code and content type, and echo json
 	 * 
 	 * @param array $options optional
+	 * @return void
 	 */
 	public function sendResponse(array $options=[]);
 }

src/interfaces/PaginableInterface.php

Doc Comments +1 added lines

@@ -8,6 +8,7 @@
 	 * @param string $nextHref     optional
 	 * @param string $firstHref    optional
 	 * @param string $lastHref     optional
+	 * @return void
 	 */
 	public function setPaginationLinks($previousHref=null, $nextHref=null, $firstHref=null, $lastHref=null);
 }

src/interfaces/ProfileInterface.php

Doc Comments +1 added lines

@@ -19,6 +19,7 @@
 	 * @throws InputException if the alias is not different from the keyword
 	 * @throws InputException if the keyword is not known to the profile
 	 * @throws InputException if the alias is not a valid member name
+	 * @return void
 	 */
 	public function __construct(array $aliases=[]);
 	

src/objects/RelationshipsObject.php

Doc Comments +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
 	/**
 	 * @internal
 	 * 
-	 * @return string[]
+	 * @return integer[]
 	 */
 	public function getKeys() {
 		return array_keys($this->relationships);