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

[mailshears.git] / lib / mv / mv_runner.rb

diff --git a/lib/mv/mv_runner.rb b/lib/mv/mv_runner.rb
index 0e5e909e268944c25f2003e82eceb84bcc5b7bda..fe44e5c244d3fe4cff66f140bb4d684ca903364a 100644 (file)
--- a/lib/mv/mv_runner.rb
+++ b/lib/mv/mv_runner.rb
@@ -2,9 +2,23 @@ require 'common/domain'
 require 'common/errors'
 require 'common/runner'
 
+# Perform the moving (renaming) of users/domains using {MvPlugin}s.
+#
 class MvRunner
   include Runner
 
+  # Run *plugin* to move the user *src* to *dst*. The method
+  # signature includes the unused *cfg* for consistency with the
+  # runners that do need a {Configuration}.
+  #
+  # @param cfg [Configuration] unused.
+  #
+  # @param plugin [Class] plugin class that will perform the move.
+  #
+  # @param src [User] the source user to be moved.
+  #
+  # @param dst [User] the destination user being moved to.
+  #
   def run(cfg, plugin, src, dst)
 
     if src.is_a?(Domain) or dst.is_a?(Domain) then