MAGETWO-36836: Other lib api annotations

- Changes based on architectural code review feedback.

Author: safwkhan

lib/internal/Magento/Framework/Archive/ArchiveInterface.php

@@ -11,6 +11,9 @@
  */
 namespace Magento\Framework\Archive;
 
+/**
+ * @api
+ */
 interface ArchiveInterface
 {
     /**
@@ -19,7 +22,6 @@ interface ArchiveInterface
      * @param string $source
      * @param string $destination
      * @return string
-     * @api
      */
     public function pack($source, $destination);
 
@@ -29,7 +31,6 @@ public function pack($source, $destination);
      * @param string $source
      * @param string $destination
      * @return string
-     * @api
      */
     public function unpack($source, $destination);
 }

lib/internal/Magento/Framework/Stdlib/Cookie/CookieReaderInterface.php

@@ -8,6 +8,7 @@
 
 /**
  * CookieReaderInterface provides the ability to read cookies sent in a request.
+ * @api
  */
 interface CookieReaderInterface
 {
@@ -17,7 +18,6 @@ interface CookieReaderInterface
      * @param string $name
      * @param string|null $default The default value to return if no value could be found for the given $name.
      * @return string|null
-     * @api
      */
     public function getCookie($name, $default = null);
 }

lib/internal/Magento/Framework/Stdlib/Cookie/CookieScopeInterface.php

@@ -7,6 +7,7 @@
 
 /**
  * CookieScope is used to store default scope metadata.
+ * @api
  */
 interface CookieScopeInterface
 {
@@ -16,7 +17,6 @@ interface CookieScopeInterface
      *
      * @param SensitiveCookieMetadata|null $override
      * @return SensitiveCookieMetadata
-     * @api
      */
     public function getSensitiveCookieMetadata(SensitiveCookieMetadata $override = null);
 
@@ -26,7 +26,6 @@ public function getSensitiveCookieMetadata(SensitiveCookieMetadata $override = n
      *
      * @param PublicCookieMetadata|null $override
      * @return PublicCookieMetadata
-     * @api
      */
     public function getPublicCookieMetadata(PublicCookieMetadata $override = null);
 
@@ -36,7 +35,6 @@ public function getPublicCookieMetadata(PublicCookieMetadata $override = null);
      *
      * @param CookieMetadata|null $override
      * @return CookieMetadata
-     * @api
      */
     public function getCookieMetadata(CookieMetadata $override = null);
 }

lib/internal/Magento/Framework/Stdlib/CookieManagerInterface.php

@@ -20,6 +20,7 @@
  * The cookie manager will make it possible for an application to indicate if a cookie contains sensitive data,
  * this will allow extra protection to be added to the contents of the cookie as well sending directives to the browser
  * about how the cookie should be stored and whether JavaScript can access the cookie.
+ * @api
  */
 interface CookieManagerInterface extends CookieReaderInterface
 {
@@ -36,7 +37,6 @@ interface CookieManagerInterface extends CookieReaderInterface
      * there is still no guarantee that the browser received and accepted the cookie.
      * @throws CookieSizeLimitReachedException Thrown when the cookie is too big to store any additional data.
      * @throws InputException If the cookie name is empty or contains invalid characters.
-     * @api
      */
     public function setSensitiveCookie($name, $value, SensitiveCookieMetadata $metadata = null);
 
@@ -53,7 +53,6 @@ public function setSensitiveCookie($name, $value, SensitiveCookieMetadata $metad
      * @throws FailureToSendException If cookie couldn't be sent to the browser.
      * @throws CookieSizeLimitReachedException Thrown when the cookie is too big to store any additional data.
      * @throws InputException If the cookie name is empty or contains invalid characters.
-     * @api
      */
     public function setPublicCookie($name, $value, PublicCookieMetadata $metadata = null);
 
@@ -67,7 +66,6 @@ public function setPublicCookie($name, $value, PublicCookieMetadata $metadata =
      *     If this exception isn't thrown, there is still no guarantee that the browser
      *     received and accepted the request to delete this cookie.
      * @throws InputException If the cookie name is empty or contains invalid characters.
-     * @api
      */
     public function deleteCookie($name, CookieMetadata $metadata = null);
 }

lib/internal/Magento/Framework/Stdlib/DateTime/DateTime.php

@@ -103,7 +103,6 @@ public function date($format = null, $input = null)
      *
      * @param  int|string $input date in current timezone
      * @return int
-     * @api
      */
     public function gmtTimestamp($input = null)
     {
@@ -130,7 +129,6 @@ public function gmtTimestamp($input = null)
      *
      * @param  int|string $input date in GMT timezone
      * @return int
-     * @api
      */
     public function timestamp($input = null)
     {

lib/internal/Magento/Framework/Stdlib/DateTime/TimezoneInterface.php

@@ -8,21 +8,22 @@
 
 namespace Magento\Framework\Stdlib\DateTime;
 
+/**
+ * @api
+ */
 interface TimezoneInterface
 {
     /**
      * Return path to default timezone
      *
      * @return string
-     * @api
      */
     public function getDefaultTimezonePath();
 
     /**
      * Retrieve timezone code
      *
      * @return string
-     * @api
      */
     public function getDefaultTimezone();
 
@@ -31,15 +32,13 @@ public function getDefaultTimezone();
      *
      * @param   int $type
      * @return  string
-     * @api
      */
     public function getDateFormat($type = \IntlDateFormatter::SHORT);
 
     /**
      * Retrieve short date format with 4-digit year
      *
      * @return  string
-     * @api
      */
     public function getDateFormatWithLongYear();
 
@@ -48,7 +47,6 @@ public function getDateFormatWithLongYear();
      *
      * @param   string $type
      * @return  string
-     * @api
      */
     public function getTimeFormat($type = null);
 
@@ -57,7 +55,6 @@ public function getTimeFormat($type = null);
      *
      * @param   string $type
      * @return  string
-     * @api
      */
     public function getDateTimeFormat($type);
 
@@ -68,7 +65,6 @@ public function getDateTimeFormat($type);
      * @param string $locale
      * @param bool               $useTimezone
      * @return \DateTime
-     * @api
      */
     public function date($date = null, $locale = null, $useTimezone = true);
 
@@ -79,7 +75,6 @@ public function date($date = null, $locale = null, $useTimezone = true);
      * @param   string|integer|\DateTime|array|null $date date in UTC
      * @param   boolean $includeTime flag for including time to date
      * @return  \DateTime
-     * @api
      */
     public function scopeDate($scope = null, $date = null, $includeTime = false);
 
@@ -89,7 +84,6 @@ public function scopeDate($scope = null, $date = null, $includeTime = false);
      *
      * @param   mixed $scope
      * @return  int
-     * @api
      */
     public function scopeTimeStamp($scope = null);
 
@@ -100,7 +94,6 @@ public function scopeTimeStamp($scope = null);
      * @param int $format
      * @param bool $showTime
      * @return string
-     * @api
      */
     public function formatDate(
         $date = null,
@@ -112,7 +105,6 @@ public function formatDate(
      * Gets the scope config timezone
      *
      * @return string
-     * @api
      */
     public function getConfigTimezone();
 
@@ -123,7 +115,6 @@ public function getConfigTimezone();
      * @param string|null $dateFrom
      * @param string|null $dateTo
      * @return bool
-     * @api
      */
     public function isScopeDateInInterval($scope, $dateFrom = null, $dateTo = null);
 
@@ -135,7 +126,6 @@ public function isScopeDateInInterval($scope, $dateFrom = null, $dateTo = null);
      * @param null $timezone
      * @param string|null $pattern
      * @return string
-     * @api
      */
     public function formatDateTime(
         \DateTimeInterface $date,

lib/internal/Magento/Framework/Validator/ValidatorInterface.php

@@ -7,30 +7,30 @@
  */
 namespace Magento\Framework\Validator;
 
+/**
+ * @api
+ */
 interface ValidatorInterface extends \Zend_Validate_Interface
 {
     /**
      * Set translator instance.
      *
      * @param \Magento\Framework\Translate\AdapterInterface|null $translator
      * @return \Magento\Framework\Validator\ValidatorInterface
-     * @api
      */
     public function setTranslator($translator = null);
 
     /**
      * Get translator.
      *
      * @return \Magento\Framework\Translate\AdapterInterface|null
-     * @api
      */
     public function getTranslator();
 
     /**
      * Check that translator is set.
      *
      * @return boolean
-     * @api
      */
     public function hasTranslator();
 }