From 9412f260aeba62b57053fcbf3996c01e292d0540 Mon Sep 17 00:00:00 2001
From: Molkobain <lajarige.guillaume@free.fr>
Date: Mon, 24 Feb 2020 11:01:24 +0100
Subject: [PATCH] PHPDoc

---
 application/applicationextension.inc.php | 23 +++++++++++++++++++++++
 application/loginform.class.inc.php      | 24 +++++++++++++++++++++---
 2 files changed, 44 insertions(+), 3 deletions(-)

diff --git a/application/applicationextension.inc.php b/application/applicationextension.inc.php
index f4d751443..0ce09201a 100644
--- a/application/applicationextension.inc.php
+++ b/application/applicationextension.inc.php
@@ -69,6 +69,9 @@ interface iLoginFSMExtension extends iLoginExtension
  */
 abstract class AbstractLoginFSMExtension implements iLoginFSMExtension
 {
+	/**
+	 * @inheritDoc
+	 */
 	public abstract function ListSupportedLoginModes();
 
 	/**
@@ -160,21 +163,41 @@ abstract class AbstractLoginFSMExtension implements iLoginFSMExtension
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+	 *
+	 * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_RETURN_IGNORE
+	 */
 	protected function OnCredentialsOK(&$iErrorCode)
 	{
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+	 *
+	 * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_RETURN_IGNORE
+	 */
 	protected function OnUsersOK(&$iErrorCode)
 	{
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+	 *
+	 * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_RETURN_IGNORE
+	 */
 	protected function OnConnected(&$iErrorCode)
 	{
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @param int $iErrorCode (see LoginWebPage::EXIT_CODE_...)
+	 *
+	 * @return int LoginWebPage::LOGIN_FSM_RETURN_ERROR, LoginWebPage::LOGIN_FSM_RETURN_OK or LoginWebPage::LOGIN_FSM_RETURN_IGNORE
+	 */
 	protected function OnError(&$iErrorCode)
 	{
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
diff --git a/application/loginform.class.inc.php b/application/loginform.class.inc.php
index dc4166b61..a4fb99db5 100644
--- a/application/loginform.class.inc.php
+++ b/application/loginform.class.inc.php
@@ -1,12 +1,15 @@
 <?php
 
 /**
- * Class LoginForm
- *
  * @copyright   Copyright (C) 2010-2019 Combodo SARL
  * @license     http://opensource.org/licenses/AGPL-3.0
  */
 
+/**
+ * Class LoginForm
+ *
+ * @since 2.7.0
+ */
 class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
 {
 	private $bForceFormOnError = false;
@@ -21,6 +24,9 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
 		return array('form');
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function OnReadCredentials(&$iErrorCode)
 	{
 		if (!isset($_SESSION['login_mode']) || ($_SESSION['login_mode'] == 'form'))
@@ -51,6 +57,9 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function OnCheckCredentials(&$iErrorCode)
 	{
 		if ($_SESSION['login_mode'] == 'form')
@@ -66,6 +75,9 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function OnCredentialsOK(&$iErrorCode)
 	{
 		if ($_SESSION['login_mode'] == 'form')
@@ -85,6 +97,9 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function OnError(&$iErrorCode)
 	{
 		if ($_SESSION['login_mode'] == 'form')
@@ -94,6 +109,9 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
 		return LoginWebPage::LOGIN_FSM_CONTINUE;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	protected function OnConnected(&$iErrorCode)
 	{
 		if ($_SESSION['login_mode'] == 'form')
@@ -105,7 +123,7 @@ class LoginForm extends AbstractLoginFSMExtension implements iLoginUIExtension
 	}
 
 	/**
-	 * @return LoginTwigContext
+	 * @inheritDoc
 	 * @throws \Exception
 	 */
 	public function GetTwigContext()