Issue #2261391 by pwolanin, Crell: Fix up throws and other docs for FactoryInterface

8.0.x
Jennifer Hodgdon 2014-05-07 17:00:38 -07:00
parent 6c410da26e
commit 4e42a5ba28
1 changed files with 6 additions and 3 deletions

View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @file * @file
* Definition of Drupal\Component\Plugin\Factory\FactoryInterface. * Contains \Drupal\Component\Plugin\Factory\FactoryInterface.
*/ */
namespace Drupal\Component\Plugin\Factory; namespace Drupal\Component\Plugin\Factory;
@ -12,15 +12,18 @@ namespace Drupal\Component\Plugin\Factory;
interface FactoryInterface { interface FactoryInterface {
/** /**
* Returns a preconfigured instance of a plugin. * Returns a pre-configured instance of a plugin.
* *
* @param string $plugin_id * @param string $plugin_id
* The id of the plugin being instantiated. * The ID of the plugin being instantiated.
* @param array $configuration * @param array $configuration
* An array of configuration relevant to the plugin instance. * An array of configuration relevant to the plugin instance.
* *
* @return object * @return object
* A fully configured plugin instance. * A fully configured plugin instance.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* If the instance cannot be created, such as if the ID is invalid.
*/ */
public function createInstance($plugin_id, array $configuration = array()); public function createInstance($plugin_id, array $configuration = array());