Replaced {@inheritdoc} with the actual documentation in order to fix code style violations

Author: bnymn

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

@@ -85,23 +85,31 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * Return path to default timezone
+     *
+     * @return string
      */
     public function getDefaultTimezonePath()
     {
         return $this->_defaultTimezonePath;
     }
 
     /**
-     * {@inheritdoc}
+     * Retrieve timezone code
+     *
+     * @return string
      */
     public function getDefaultTimezone()
     {
         return 'UTC';
     }
 
     /**
-     * {@inheritdoc}
+     * Gets the scope config timezone
+     *
+     * @param string $scopeType
+     * @param string $scopeCode
+     * @return string
      */
     public function getConfigTimezone($scopeType = null, $scopeCode = null)
     {
@@ -113,7 +121,10 @@ public function getConfigTimezone($scopeType = null, $scopeCode = null)
     }
 
     /**
-     * {@inheritdoc}
+     * Retrieve ISO date format
+     *
+     * @param   int $type
+     * @return  string
      */
     public function getDateFormat($type = \IntlDateFormatter::SHORT)
     {
@@ -125,7 +136,9 @@ public function getDateFormat($type = \IntlDateFormatter::SHORT)
     }
 
     /**
-     * {@inheritdoc}
+     * Retrieve short date format with 4-digit year
+     *
+     * @return  string
      */
     public function getDateFormatWithLongYear()
     {
@@ -137,7 +150,10 @@ public function getDateFormatWithLongYear()
     }
 
     /**
-     * {@inheritdoc}
+     * Retrieve ISO time format
+     *
+     * @param   string $type
+     * @return  string
      */
     public function getTimeFormat($type = \IntlDateFormatter::SHORT)
     {
@@ -149,15 +165,24 @@ public function getTimeFormat($type = \IntlDateFormatter::SHORT)
     }
 
     /**
-     * {@inheritdoc}
+     * Retrieve ISO datetime format
+     *
+     * @param   string $type
+     * @return  string
      */
     public function getDateTimeFormat($type)
     {
         return $this->getDateFormat($type) . ' ' . $this->getTimeFormat($type);
     }
 
     /**
-     * {@inheritdoc}
+     * Create \DateTime object for current locale
+     *
+     * @param mixed $date
+     * @param string $locale
+     * @param bool $useTimezone
+     * @param bool $includeTime
+     * @return \DateTime
      */
     public function date($date = null, $locale = null, $useTimezone = true, $includeTime = true)
     {
@@ -191,7 +216,12 @@ public function date($date = null, $locale = null, $useTimezone = true, $include
     }
 
     /**
-     * {@inheritdoc}
+     * Create \DateTime object with date converted to scope timezone and scope Locale
+     *
+     * @param   mixed $scope Information about scope
+     * @param   string|integer|\DateTime|array|null $date date in UTC
+     * @param   boolean $includeTime flag for including time to date
+     * @return  \DateTime
      */
     public function scopeDate($scope = null, $date = null, $includeTime = false)
     {
@@ -204,7 +234,12 @@ public function scopeDate($scope = null, $date = null, $includeTime = false)
     }
 
     /**
-     * {@inheritdoc}
+     * Format date using current locale options and time zone.
+     *
+     * @param \DateTime|null $date
+     * @param int $format
+     * @param bool $showTime
+     * @return string
      */
     public function formatDate($date = null, $format = \IntlDateFormatter::SHORT, $showTime = false)
     {
@@ -218,7 +253,12 @@ public function formatDate($date = null, $format = \IntlDateFormatter::SHORT, $s
     }
 
     /**
-     * {@inheritdoc}
+     * Get scope timestamp
+     *
+     * Timestamp will be built with scope timezone settings
+     *
+     * @param   mixed $scope
+     * @return  int
      */
     public function scopeTimeStamp($scope = null)
     {
@@ -231,7 +271,12 @@ public function scopeTimeStamp($scope = null)
     }
 
     /**
-     * {@inheritdoc}
+     * Checks if current date of the given scope (in the scope timezone) is within the range
+     *
+     * @param int|string|\Magento\Framework\App\ScopeInterface $scope
+     * @param string|null $dateFrom
+     * @param string|null $dateTo
+     * @return bool
      */
     public function isScopeDateInInterval($scope, $dateFrom = null, $dateTo = null)
     {
@@ -300,6 +345,7 @@ public function formatDateTime(
 
     /**
      * Convert date from config timezone to Utc.
+     *
      * If pass \DateTime object as argument be sure that timezone is the same with config timezone
      *
      * @param string|\DateTimeInterface $date
@@ -315,6 +361,7 @@ public function convertConfigTimeToUtc($date, $format = 'Y-m-d H:i:s')
 
     /**
      * Convert date from config timezone to Utc.
+     *
      * If pass \DateTime object as argument be sure that timezone is the same with config timezone
      *
      * @param string|\DateTimeInterface $date

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

@@ -80,6 +80,7 @@ public function scopeDate($scope = null, $date = null, $includeTime = false);
 
     /**
      * Get scope timestamp
+     *
      * Timestamp will be built with scope timezone settings
      *
      * @param   mixed $scope
@@ -121,6 +122,7 @@ public function getConfigTimezone($scopeType = null, $scopeCode = null);
     public function isScopeDateInInterval($scope, $dateFrom = null, $dateTo = null);
 
     /**
+     *
      * @param string|\DateTimeInterface $date
      * @param int $dateType
      * @param int $timeType
@@ -139,19 +141,29 @@ public function formatDateTime(
     );
 
     /**
+     * Convert date from config timezone to Utc.
+     *
+     * If pass \DateTime object as argument be sure that timezone is the same with config timezone
+     *
      * @param string|\DateTimeInterface $date
      * @param string $format
+     * @throws LocalizedException
      * @return string
-     * @since 100.1.0
      * @deprecated
      */
     public function convertConfigTimeToUtc($date, $format = 'Y-m-d H:i:s');
 
     /**
-     * @param $date
+     * Convert date from config timezone to Utc.
+     *
+     * If pass \DateTime object as argument be sure that timezone is the same with config timezone
+     *
+     * @param string|\DateTimeInterface $date
      * @param string $format
      * @param string $pattern
-     * @return mixed
+     * @throws LocalizedException
+     * @return string
+     * @deprecated
      */
     public function convertConfigTimeToUtcWithPattern($date, $format = 'Y-m-d H:i:s', $pattern = 'Y-m-d H:i:s');
 }