From 5ab8eddb42a6ad4d727a3531e3a4a588c124ee0d Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Thu, 25 May 2017 09:47:47 -0700
Subject: [PATCH] (NFC) Civi\API\Kernel - Add more docblocks

---
 Civi/API/Kernel.php | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/Civi/API/Kernel.php b/Civi/API/Kernel.php
index 3571201d80ce..529d5636c537 100644
--- a/Civi/API/Kernel.php
+++ b/Civi/API/Kernel.php
@@ -153,7 +153,7 @@ public function runAuthorize($entity, $action, $params, $extra = NULL) {
    *
    * The request must be in canonical format. Exceptions will be propagated out.
    *
-   * @param $apiRequest
+   * @param array $apiRequest
    * @return array
    * @throws \API_Exception
    * @throws \Civi\API\Exception\NotImplementedException
@@ -200,7 +200,7 @@ public function boot($apiRequest) {
   }
 
   /**
-   * @param $apiRequest
+   * @param array $apiRequest
    * @throws \API_Exception
    */
   protected function validate($apiRequest) {
@@ -213,7 +213,8 @@ protected function validate($apiRequest) {
    *   The full description of the API request.
    * @throws Exception\NotImplementedException
    * @return array
-   *   Array(0 => ProviderInterface, 1 => array).
+   *   A tuple with the provider-object and a revised apiRequest.
+   *   Array(0 => ProviderInterface, 1 => array $apiRequest).
    */
   public function resolve($apiRequest) {
     /** @var ResolveEvent $resolveEvent */
@@ -249,7 +250,8 @@ public function authorize($apiProvider, $apiRequest) {
    *   The API provider responsible for executing the request.
    * @param array $apiRequest
    *   The full description of the API request.
-   * @return mixed
+   * @return array
+   *   The revised API request.
    */
   public function prepare($apiProvider, $apiRequest) {
     /** @var PrepareEvent $event */
@@ -267,6 +269,7 @@ public function prepare($apiProvider, $apiRequest) {
    * @param array $result
    *   The response to return to the client.
    * @return mixed
+   *   The revised $result.
    */
   public function respond($apiProvider, $apiRequest, $result) {
     /** @var RespondEvent $event */