From 9de11a29fb543d0bfe9a8d59b92dc105b60b3ffd Mon Sep 17 00:00:00 2001 From: Molkobain Date: Thu, 6 Feb 2020 16:23:22 +0100 Subject: [PATCH] PHPDoc --- application/applicationextension.inc.php | 59 +++++++++++++++--------- 1 file changed, 36 insertions(+), 23 deletions(-) diff --git a/application/applicationextension.inc.php b/application/applicationextension.inc.php index 59e346f8b..916ae0db9 100644 --- a/application/applicationextension.inc.php +++ b/application/applicationextension.inc.php @@ -1,20 +1,22 @@ + +/** + * Copyright (C) 2013-2020 Combodo SARL + * + * This file is part of iTop. + * + * iTop is free software; you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * iTop is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + */ use Symfony\Component\DependencyInjection\Container; @@ -30,6 +32,7 @@ require_once(APPROOT.'application/newsroomprovider.class.inc.php'); * @copyright Copyright (C) 2010-2012 Combodo SARL * @license http://opensource.org/licenses/AGPL-3.0 * @package Extensibility + * @since 2.7.0 */ interface iLoginExtension { @@ -41,6 +44,9 @@ interface iLoginExtension public function ListSupportedLoginModes(); } +/** + * @since 2.7.0 + */ interface iLoginFSMExtension extends iLoginExtension { /** @@ -58,6 +64,9 @@ interface iLoginFSMExtension extends iLoginExtension public function LoginAction($sLoginState, &$iErrorCode); } +/** + * @since 2.7.0 + */ abstract class AbstractLoginFSMExtension implements iLoginFSMExtension { public abstract function ListSupportedLoginModes(); @@ -172,6 +181,9 @@ abstract class AbstractLoginFSMExtension implements iLoginFSMExtension } } +/** + * @since 2.7.0 + */ interface iLogoutExtension extends iLoginExtension { /** @@ -180,6 +192,9 @@ interface iLogoutExtension extends iLoginExtension public function LogoutAction(); } +/** + * @since 2.7.0 + */ interface iLoginUIExtension extends iLoginExtension { /** @@ -188,7 +203,11 @@ interface iLoginUIExtension extends iLoginExtension public function GetTwigContext(); } - +/** + * @api + * @package Extensibility + * @since 2.7.0 + */ interface iPreferencesExtension { /** @@ -589,7 +608,6 @@ abstract class ApplicationPopupMenuItem * * @param string $sUID The unique identifier of this menu in iTop... make sure you pass something unique enough * @param string $sLabel The display label of the menu (must be localized) - * @param array $aCssClasses The CSS classes to add to the menu */ public function __construct($sUID, $sLabel) { @@ -1082,11 +1100,6 @@ class RestResult /** * Default constructor - ok! - * - * @param DBObject $oObject The object being reported - * @param string $sAttCode The attribute code (must be valid) - * - * @return string A scalar representation of the value */ public function __construct() {