Add PhpDoc headers to all components

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / system / endpoint / IController.class.php

diff --git a/wcfsetup/install/files/lib/system/endpoint/IController.class.php b/wcfsetup/install/files/lib/system/endpoint/IController.class.php
index 2d34af7a5bb097b42d2d96a8b97e6b9e3357ce40..de0d9e71ec61391c95db9523192dc6737bdcd9df 100644 (file)
--- a/wcfsetup/install/files/lib/system/endpoint/IController.class.php
+++ b/wcfsetup/install/files/lib/system/endpoint/IController.class.php
@@ -6,9 +6,21 @@ use CuyZ\Valinor\Mapper\MappingError;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
 
+/**
+ * Handles incoming API requests, relying on the `RequestType` attributes to
+ * register the endpoint. The endpoint can contain placeholders for parameters.
+ *
+ * @author Alexander Ebert
+ * @copyright 2001-2024 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.1
+ */
 interface IController
 {
     /**
+     * Invokes the controller, passing in any placeholders from the endpoint in
+     * the `$variables` array.
+     *
      * @param array<string, string> $variables
      * @throws MappingError
      */