Issue #2344045 by jhodgdon, EclipseGc, chx, CocoaBean, andrei.dincu,...

Issue #2344045 by jhodgdon, EclipseGc, chx, CocoaBean, andrei.dincu, tim.plunkett, fago: ContextInterface needs documentation

core/lib/Drupal/Component/Plugin/Context/ContextDefinitionInterface.php

@@ -3,7 +3,9 @@
 namespace Drupal\Component\Plugin\Context;
 
 /**
- * Interface for context definitions.
+ * Interface used to define definition objects found in ContextInterface.
+ *
+ * @see \Drupal\Component\Plugin\Context\ContextInterface
  *
  * @todo WARNING: This interface is going to receive some additions as part of
  * https://www.drupal.org/node/2346999.

core/lib/Drupal/Component/Plugin/Context/ContextInterface.php

@@ -3,7 +3,14 @@
 namespace Drupal\Component\Plugin\Context;
 
 /**
- * A generic context interface for wrapping data a plugin needs to operate.
+ * Provides data and definitions for plugins during runtime and administration.
+ *
+ * Plugin contexts are satisfied by ContextInterface implementing objects.
+ * These objects always contain a definition of what data they will provide
+ * during runtime. During run time, ContextInterface implementing objects must
+ * also provide the corresponding data value.
+ *
+ * @see \Drupal\Component\Plugin\Context\ContextDefinitionInterface
  */
 interface ContextInterface {
 

core/lib/Drupal/Core/Plugin/Context/ContextDefinitionInterface.php

@@ -5,7 +5,10 @@
 use Drupal\Component\Plugin\Context\ContextDefinitionInterface as ComponentContextDefinitionInterface;
 
 /**
- * Interface for context definitions.
+ * Interface to define definition objects in ContextInterface via TypedData.
+ *
+ * @see \Drupal\Component\Plugin\Context\ContextDefinitionInterface
+ * @see \Drupal\Core\Plugin\Context\ContextInterface
  */
 interface ContextDefinitionInterface extends ComponentContextDefinitionInterface {
 

core/lib/Drupal/Core/Plugin/Context/ContextInterface.php

@@ -6,7 +6,10 @@
 use Drupal\Core\Cache\CacheableDependencyInterface;
 
 /**
- * Interface for context.
+ * Context data and definitions for plugins supporting caching and return docs.
+ *
+ * @see \Drupal\Component\Plugin\Context\ContextInterface
+ * @see \Drupal\Core\Plugin\Context\ContextDefinitionInterface
  */
 interface ContextInterface extends ComponentContextInterface, CacheableDependencyInterface {