locomotivemtl / charcoal-cms

src/Charcoal/Cms/Support/Traits/EventManagerAwareTrait.php

Doc Comments +4 added lines, -4 removed lines

@@ -27,7 +27,7 @@ 
     /**
      * Formatted event list
      * Return the entries for the current page
-     * @return \Generator|void
+     * @return \Generator
      */
     public function eventsList()
     {
@@ -41,7 +41,7 @@ 
     /**
      * Formatted event archive list
      * Returns the entries for the current page.
-     * @return \Generator|void
+     * @return \Generator
      */
     public function eventArchiveList()
     {
@@ -73,7 +73,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return \Generator
      */
     public function featEvents()
     {
@@ -122,7 +122,7 @@ 
 
     /**
      * Amount of events (total)
-     * @return integer How many events?
+     * @return boolean How many events?
      */
     public function numEvent()
     {

src/Charcoal/Cms/Support/Traits/NewsManagerAwareTrait.php

Doc Comments +3 added lines, -3 removed lines

@@ -32,7 +32,7 @@ 
     /**
      * Formatted news list
      * Returns the entries for the current page.
-     * @return \Generator|void
+     * @return \Generator
      */
     public function newsList()
     {
@@ -45,7 +45,7 @@ 
     /**
      * Formatted news archive list
      * Returns the entries for the current page.
-     * @return \Generator|void
+     * @return \Generator
      */
     public function newsArchiveList()
     {
@@ -124,7 +124,7 @@ 
 
     /**
      * Amount of news (total)
-     * @return integer How many news?
+     * @return boolean How many news?
      */
     public function numNews()
     {

src/Charcoal/Cms/Support/Traits/SectionLoaderAwareTrait.php

Doc Comments +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
 
     /**
      * Gets latest route for the given slug.
-     * @return string The latest url.
+     * @return \Closure The latest url.
      */
     public function routes()
     {

src/Charcoal/Cms/AbstractEvent.php

Doc Comments +3 added lines, -3 removed lines

@@ -230,7 +230,7 @@ 
     }
 
     /**
-     * @param  string|DateTimeInterface $startDate Event starting date.
+     * @param  string $startDate Event starting date.
      * @throws InvalidArgumentException If the timestamp is invalid.
      * @return self
      */
@@ -263,7 +263,7 @@ 
     }
 
     /**
-     * @param  string|DateTimeInterface $endDate Event end date.
+     * @param  null|DateTimeInterface $endDate Event end date.
      * @throws InvalidArgumentException If the timestamp is invalid.
      * @return self
      */
@@ -319,7 +319,7 @@ 
     }
 
     /**
-     * @return Translation|string|null
+     * @return null|Translation
      */
     public function defaultMetaDescription()
     {

src/Charcoal/Cms/Config/NewsConfig.php

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
     }
 
     /**
-     * @return boolean Entry cycle.
+     * @return string Entry cycle.
      */
     public function entryCycle()
     {

src/Charcoal/Cms/Support/Helpers/DateHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -263,7 +263,7 @@
     }
 
     /**
-     * @param mixed $format DateTime to be formatted.
+     * @param string $format DateTime to be formatted.
      * @return mixed
      */
     private function crossPlatformFormat($format)