Document everything with YARD and fix some bugs along the way.

[mailshears.git] / lib / prune / plugins / roundcube.rb

diff --git a/lib/prune/plugins/roundcube.rb b/lib/prune/plugins/roundcube.rb
index 5869b02cabe20aeb2e78ebc5012173d624427a0b..929739297b46a9fe1d1a51ea347816091a5ece1f 100644 (file)
--- a/lib/prune/plugins/roundcube.rb
+++ b/lib/prune/plugins/roundcube.rb
@@ -3,6 +3,12 @@ require 'pg'
 require 'prune/prune_plugin'
 require 'rm/plugins/roundcube'
 
+
+# Handle the pruning of Roundcube users from its database. This class
+# doesn't need to do anything; by inheriting from {RoundcubeRm}, we get
+# its {RoundcubeRm#remove_user} method and that's all we need to prune.
+#
 class RoundcubePrune < RoundcubeRm
+  # Needed for the magic includers <tt>run()</tt> method.
   include PrunePlugin
 end