Tweak phpdoc to make it more clear what each of these do.

horde · Jan 21, 2016 · adc1afd · adc1afd
1 parent 3156014
commit adc1afd
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/kronolith/lib/Driver.php b/kronolith/lib/Driver.php
@@ -443,6 +443,9 @@ protected function _move($eventId, $newCalendar)
     /**
      * Stub to be overridden in the child class.
      *
+     * Note: This method only "Purges" the calendar - removing the
+     * events, it doesn't remove the calendar itself.
+     *
      * @throws Kronolith_Exception
      */
     public function delete($calendar)

diff --git a/kronolith/lib/Driver/Kolab.php b/kronolith/lib/Driver/Kolab.php
@@ -495,7 +495,7 @@ protected function _move($eventId, $newCalendar)
     }
 
     /**
-     * Delete a calendar and all its events.
+     * Delete all of a calendar's events.
      *
      * @param string $calendar  The name of the calendar to delete.
      *

diff --git a/kronolith/lib/Driver/Sql.php b/kronolith/lib/Driver/Sql.php
@@ -752,7 +752,7 @@ protected function _move($eventId, $newCalendar)
     }
 
     /**
-     * Delete a calendar and all its events.
+     * Delete all of a calendar's events.
      *
      * @param string $calendar  The name of the calendar to delete.
      *

diff --git a/kronolith/lib/Kronolith.php b/kronolith/lib/Kronolith.php
@@ -1337,7 +1337,7 @@ public static function updateShare(&$calendar, $info)
     }
 
     /**
-     * Deletes a share.
+     * Deletes a share and removes all events associated with it.
      *
      * @param Horde_Share $calendar  The share to delete.
      *