Added comments for methods. [skip ci]

Author: rennokki

Diff for: src/TimeRange.php

@@ -9,6 +9,13 @@ class TimeRange
     protected $timeRangeString;
     protected $carbonInstance = Carbon::class;
 
+    /**
+     * Create a new TimeRange instance.
+     * 
+     * @param string $timeRangeString
+     * @param Carbon $carbonInstance
+     * @return void
+     */
     public function __construct($timeRangeString, $carbonInstance = null)
     {
         $this->timeRangeString = $timeRangeString;
@@ -20,6 +27,8 @@ public function __construct($timeRangeString, $carbonInstance = null)
 
     /**
      * Check if the string provided is a TimeRange formatted string.
+     * 
+     * @return bool
      */
     public function isValidTimeRange()
     {
@@ -28,6 +37,8 @@ public function isValidTimeRange()
 
     /**
      * Check if the string provided is a valid hour:minute formatted string.
+     * 
+     * @return bool
      */
     public function isValidHourMinute($hourMinute)
     {
@@ -36,6 +47,9 @@ public function isValidHourMinute($hourMinute)
 
     /**
      * Check if a specific hour:minute is in the timerange.
+     * 
+     * @param string $hourMinute The time in format hour:minute
+     * @return bool
      */
     public function isInTimeRange($hourMinute)
     {
@@ -54,6 +68,8 @@ public function isInTimeRange($hourMinute)
 
     /**
      * Get the start Carbon instance as 1st January 2018, and a specified hour.
+     * 
+     * @return Carbon
      */
     public function getStartCarbonInstance()
     {
@@ -62,6 +78,8 @@ public function getStartCarbonInstance()
 
     /**
      * Get the end Carbon instance as 1st/2nd January 2018, at the right hour and minute.
+     * 
+     * @return Carbon
      */
     public function getEndCarbonInstance()
     {
@@ -70,6 +88,8 @@ public function getEndCarbonInstance()
 
     /**
      * Difference in hours between the both ends.
+     * 
+     * @return int The difference, in hours.
      */
     public function diffInHours()
     {
@@ -82,6 +102,8 @@ public function diffInHours()
 
     /**
      * Difference in minutes between the both ends.
+     * 
+     * @return int The difference, in minutes.
      */
     public function diffInMinutes()
     {
@@ -94,6 +116,8 @@ public function diffInMinutes()
 
     /**
      * Get the hour of the starting part.
+     * 
+     * @return int
      */
     public function getStartHour()
     {
@@ -106,6 +130,8 @@ public function getStartHour()
 
     /**
      * Get the minute of the starting part.
+     * 
+     * @return int
      */
     public function getStartMinute()
     {
@@ -118,6 +144,8 @@ public function getStartMinute()
 
     /**
      * Get the hour of the ending part.
+     * 
+     * @return int
      */
     public function getEndHour()
     {
@@ -130,6 +158,8 @@ public function getEndHour()
 
     /**
      * Get the minute of the ending part.
+     * 
+     * @return int
      */
     public function getEndMinute()
     {
@@ -144,6 +174,8 @@ public function getEndMinute()
      * Get the time range in array format.
      * This will return something like ['08:00', '17:00']
      * Use get[Start|End][Hour|Minute]() method to get the hours as integers.
+     * 
+     * @return array
      */
     public function toArray()
     {

Diff for: src/Traits/HasSchedule.php

@@ -16,6 +16,8 @@ trait HasSchedule
 
     /**
      * Returns a morphOne relationship class of the schedule.
+     * 
+     * @return morphOne The relatinship.
      */
     public function schedule()
     {
@@ -24,6 +26,8 @@ public function schedule()
 
     /**
      * Get the Schedule array or null if it doesn't have.
+     * 
+     * @return array|null The array with schedules or null.
      */
     public function getSchedule()
     {
@@ -32,6 +36,8 @@ public function getSchedule()
 
     /**
      * Get the Exclusions array or null if it doesn't have.
+     * 
+     * @return array The array with exclusions.
      */
     public function getExclusions()
     {
@@ -40,6 +46,8 @@ public function getExclusions()
 
     /**
      * Check if the model has a schedule set.
+     * 
+     * @return boolean If the binded model has a schedule already set.
      */
     public function hasSchedule()
     {
@@ -48,6 +56,9 @@ public function hasSchedule()
 
     /**
      * Set a new schedule.
+     * 
+     * @param array $scheduleArray The array with schedules.
+     * @return array The schedule array.
      */
     public function setSchedule(array $scheduleArray = [])
     {
@@ -66,6 +77,9 @@ public function setSchedule(array $scheduleArray = [])
 
     /**
      * Update the model's schedule.
+     * 
+     * @param array $scheduleArray The array with schedules that should be replaced.
+     * @return array The schedule array.
      */
     public function updateSchedule(array $scheduleArray)
     {
@@ -78,6 +92,9 @@ public function updateSchedule(array $scheduleArray)
 
     /**
      * Set exclusions.
+     * 
+     * @param array $exclusionsArray The array with exclusions.
+     * @return array The exclusions array.
      */
     public function setExclusions(array $exclusionsArray = [])
     {
@@ -94,6 +111,9 @@ public function setExclusions(array $exclusionsArray = [])
 
     /**
      * Update exclusions (alias for setExclusions).
+     * 
+     * @param array $exclusionsArray The array with exclusions.
+     * @return array The exclusions array.
      */
     public function updateExclusions(array $exclusionsArray)
     {
@@ -102,6 +122,8 @@ public function updateExclusions(array $exclusionsArray)
 
     /**
      * Delete the schedule of this model.
+     * 
+     * @return bool Wether the schedule was deleted or not.
      */
     public function deleteSchedule()
     {
@@ -110,6 +132,8 @@ public function deleteSchedule()
 
     /**
      * Delete the exclusions of this model.
+     * 
+     * @return bool|array Wether the exclusions were cleared or not.
      */
     public function deleteExclusions()
     {
@@ -126,6 +150,9 @@ public function deleteExclusions()
 
     /**
      * Check if the model is available on a certain day/date.
+     * 
+     * @param string|Carbon|DateTime $dateOrDay The datetime, date or the day.
+     * @return bool Wether it is available on that day.
      */
     public function isAvailableOn($dateOrDay)
     {
@@ -162,6 +189,9 @@ public function isAvailableOn($dateOrDay)
 
     /**
      * Check if the model is unavailable on a certain day/date.
+     *
+     * @param string|Carbon|DateTime $dateOrDay The datetime, date or the day.
+     * @return bool Wether it is unavailable on that day.
      */
     public function isUnavailableOn($dateOrDay)
     {
@@ -170,6 +200,10 @@ public function isUnavailableOn($dateOrDay)
 
     /**
      * Check if the model is available on a certain day/date and time.
+     * 
+     * @param string|Carbon|DateTime $dateOrDay The datetime, date or the day.
+     * @param string The time.
+     * @return bool Wether it is available on that day, at a certain time.
      */
     public function isAvailableOnAt($dateOrDay, $time)
     {
@@ -212,6 +246,10 @@ public function isAvailableOnAt($dateOrDay, $time)
 
     /**
      * Check if the model is unavailable on a certain day/date and time.
+     * 
+     * @param string|Carbon|DateTime $dateOrDay The datetime, date or the day.
+     * @param string The time.
+     * @return bool Wether it is unavailable on that day, at a certain time.
      */
     public function isUnavailableOnAt($dateOrDay, $time)
     {
@@ -220,6 +258,9 @@ public function isUnavailableOnAt($dateOrDay, $time)
 
     /**
      * Get the amount of hours on a certain day.
+     * 
+     * @param string|Carbon|DateTime $dateOrDay The datetime, date or the day.
+     * @return int The amount of hours on that day.
      */
     public function getHoursOn($dateOrDay)
     {
@@ -261,6 +302,9 @@ public function getHoursOn($dateOrDay)
 
     /**
      * Get the amount of minutes on a certain day.
+     * 
+    * @param string|Carbon|DateTime $dateOrDay The datetime, date or the day.
+     * @return int The amount of minutes on that day.
      */
     public function getMinutesOn($dateOrDay)
     {