merged branch franmomu/add_phpdoc_to_authentication_events (PR #6831)

This PR was merged into the 2.1 branch.

Commits
-------

e7624b6 [Security] Add PHPDoc to AuthenticationEvents

Discussion
----------

[Security] Added PHPDoc to AuthenticationEvents

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets |
| License       | MIT
| Doc PR        |

1 files changed, 19 insertions, 0 deletions

diff --git a/Core/AuthenticationEvents.php b/Core/AuthenticationEvents.php
index 1e0e6ff..90b7142 100644
--- a/Core/AuthenticationEvents.php
+++ b/Core/AuthenticationEvents.php
@@ -13,7 +13,26 @@ namespace Symfony\Component\Security\Core;
 
 final class AuthenticationEvents
 {
+    /**
+     * The AUTHENTICATION_SUCCESS event occurs after a user is authenticated
+     * by one provider.
+     *
+     * The event listener method receives a
+     * Symfony\Component\Security\Core\Event\AuthenticationEvent instance.
+     *
+     * @var string
+     */
     const AUTHENTICATION_SUCCESS = 'security.authentication.success';
 
+    /**
+     * The AUTHENTICATION_FAILURE event occurs after a user cannot be
+     * authenticated by any of the providers.
+     *
+     * The event listener method receives a
+     * Symfony\Component\Security\Core\Event\AuthenticationFailureEvent
+     * instance.
+     *
+     * @var string
+     */
     const AUTHENTICATION_FAILURE = 'security.authentication.failure';
 }