MAGETWO-35004: Investigate and Annotate @api to classes and/or methods

Author: Dale Sikkema

lib/internal/Magento/Framework/App/Config/Data/ProcessorFactory.php

@@ -30,21 +30,22 @@ public function __construct(\Magento\Framework\ObjectManagerInterface $objectMan
     /**
      * Get concrete Processor Interface instance
      *
-     * @param string $model
+     * @param string $processorModel Classname of the instance to get
      * @return ProcessorInterface
-     * @throws \InvalidArgumentException
+     * @throws \InvalidArgumentException In case the given classname is not an instance of ProcessorInterface
+     * @api
      */
-    public function get($model)
+    public function get($processorModel)
     {
-        if (!isset($this->_pool[$model])) {
-            $instance = $this->_objectManager->create($model);
+        if (!isset($this->_pool[$processorModel])) {
+            $instance = $this->_objectManager->create($processorModel);
             if (!$instance instanceof ProcessorInterface) {
                 throw new \InvalidArgumentException(
-                    $model . ' is not instance of \Magento\Framework\App\Config\Data\ProcessorInterface'
+                    $processorModel . ' is not instance of \Magento\Framework\App\Config\Data\ProcessorInterface'
                 );
             }
-            $this->_pool[$model] = $instance;
+            $this->_pool[$processorModel] = $instance;
         }
-        return $this->_pool[$model];
+        return $this->_pool[$processorModel];
     }
 }

lib/internal/Magento/Framework/App/Config/Data/ProcessorInterface.php

@@ -1,19 +1,22 @@
 <?php
 /**
- * Processor interface
- *
  * Copyright © 2015 Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Framework\App\Config\Data;
 
+/**
+ * Processes data from admin store configuration fields
+ *
+ * @api
+ */
 interface ProcessorInterface
 {
     /**
      * Process config value
      *
-     * @param string $value
-     * @return string
+     * @param string $value Raw value of the configuration field
+     * @return string Processed value
      */
     public function processValue($value);
 }

lib/internal/Magento/Framework/App/Config/DataInterface.php

@@ -5,11 +5,21 @@
  */
 namespace Magento\Framework\App\Config;
 
+/**
+ * @api
+ */
 interface DataInterface
 {
     /**
      * @param string|null $path
      * @return string|array
      */
     public function getValue($path);
+
+    /**
+     * @param string $path
+     * @param mixed $value
+     * @return void
+     */
+    public function setValue($path, $value);
 }

lib/internal/Magento/Framework/App/Config/Resource/ConfigInterface.php

@@ -6,12 +6,14 @@
 namespace Magento\Framework\App\Config\Resource;
 
 /**
- * Resource Config Interface
+ * Resource for storing store configuration values
+ *
+ * @api
  */
 interface ConfigInterface
 {
     /**
-     * Save config value
+     * Save config value to the storage resource
      *
      * @param string $path
      * @param string $value
@@ -22,7 +24,7 @@ interface ConfigInterface
     public function saveConfig($path, $value, $scope, $scopeId);
 
     /**
-     * Delete config value
+     * Delete config value from the storage resource
      *
      * @param string $path
      * @param string $scope

lib/internal/Magento/Framework/Message/Factory.php

@@ -45,12 +45,14 @@ public function __construct(ObjectManagerInterface $objectManager)
     }
 
     /**
-     * Create message instance with specified parameters
+     * Create a message instance of a given type with given text.
      *
-     * @param string $type
-     * @param string $text
-     * @throws \InvalidArgumentException
+     * @param string $type The message type to create, must implement \Magento\Framework\Message\MessageInterface
+     * @param string $text The text to inject into the message
+     * @throws \InvalidArgumentException Exception gets thrown if given type does not implement MessageInterface
      * @return MessageInterface
+     *
+     * @api
      */
     public function create($type, $text)
     {

lib/internal/Magento/Framework/Object/Copy.php

@@ -47,6 +47,8 @@ public function __construct(
      * @param array|\Magento\Framework\Object $target
      * @param string $root
      * @return array|\Magento\Framework\Object|null the value of $target
+     *
+     * @api
      */
     public function copyFieldsetToTarget($fieldset, $aspect, $source, $target, $root = 'global')
     {
@@ -91,6 +93,8 @@ public function copyFieldsetToTarget($fieldset, $aspect, $source, $target, $root
      * @param array|\Magento\Framework\Object $source
      * @param string $root
      * @return array $data
+     *
+     * @api
      */
     public function getDataFromFieldset($fieldset, $aspect, $source, $root = 'global')
     {