added some doc comments

2 files changed, 32 insertions, 0 deletions

diff --git a/Http/Session/SessionAuthenticationStrategy.php b/Http/Session/SessionAuthenticationStrategy.php
index 64f787f..1d25bd9 100644
--- a/Http/Session/SessionAuthenticationStrategy.php
+++ b/Http/Session/SessionAuthenticationStrategy.php
@@ -5,6 +5,16 @@ namespace Symfony\Component\Security\Http\Session;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\HttpFoundation\Request;
 
+/**
+ * The default session strategy implementation.
+ *
+ * Supports the following strategies:
+ * NONE: the session is not changed
+ * MIGRATE: the session id is updated, attributes are kept
+ * INVALIDATE: the session id is updated, attributes are lost
+ *
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ */
 class SessionAuthenticationStrategy implements SessionAuthenticationStrategyInterface
 {
     const NONE         = 'none';
@@ -18,6 +28,9 @@ class SessionAuthenticationStrategy implements SessionAuthenticationStrategyInte
         $this->strategy = $strategy;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function onAuthentication(Request $request, TokenInterface $token)
     {
         switch ($this->strategy) {
diff --git a/Http/Session/SessionAuthenticationStrategyInterface.php b/Http/Session/SessionAuthenticationStrategyInterface.php
index c2d95c3..b248fd7 100644
--- a/Http/Session/SessionAuthenticationStrategyInterface.php
+++ b/Http/Session/SessionAuthenticationStrategyInterface.php
@@ -5,7 +5,26 @@ namespace Symfony\Component\Security\Http\Session;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\HttpFoundation\Request;
 
+/**
+ * SessionAuthenticationStrategyInterface
+ *
+ * Implementation are responsible for updating the session after an interactive
+ * authentication attempt was successful.
+ *
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ */
 interface SessionAuthenticationStrategyInterface
 {
+    /**
+     * This performs any necessary changes to the session.
+     *
+     * This method is called before the SecurityContext is populated with a
+     * Token, and only by classes inheriting from AbstractAuthenticationListener.
+     *
+     * @param Request        $request
+     * @param TokenInterface $token
+     *
+     * @return void
+     */
     function onAuthentication(Request $request, TokenInterface $token);
 }
\ No newline at end of file