From cfb3ea1a5fa931d0a5cf80f06c5e659a516bf3a8 Mon Sep 17 00:00:00 2001
From: Amine Matmati <amine.matmati@nerdery.com>
Date: Fri, 11 Mar 2016 23:15:57 -0600
Subject: [PATCH] [SecurityBundle][PHPDoc] Added method doumentation for
 SecurityFactoryInterface

---
 .../Factory/SecurityFactoryInterface.php      | 20 +++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/SecurityFactoryInterface.php b/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/SecurityFactoryInterface.php
index fce2f07580..2b3310c61a 100644
--- a/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/SecurityFactoryInterface.php
+++ b/src/Symfony/Bundle/SecurityBundle/DependencyInjection/Security/Factory/SecurityFactoryInterface.php
@@ -21,6 +21,20 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
  */
 interface SecurityFactoryInterface
 {
+    /**
+     * Configures the container services required to use the authentication listener.
+     *
+     * @param ContainerBuilder $container
+     * @param string           $id                The unique id of the firewall 
+     * @param array            $config            The options array for the listener
+     * @param string           $userProvider      The service id of the user provider
+     * @param string           $defaultEntryPoint
+     *
+     * @return array containing three values:
+     *               - the provider id
+     *               - the listener id
+     *               - the entry point id
+     */
     public function create(ContainerBuilder $container, $id, $config, $userProvider, $defaultEntryPoint);
 
     /**
@@ -31,6 +45,12 @@ interface SecurityFactoryInterface
      */
     public function getPosition();
 
+    /**
+     * Defines the configuration key used to reference the provider
+     * in the firewall configuration.
+     * 
+     * @return string
+     */
     public function getKey();
 
     public function addConfiguration(NodeDefinition $builder);