[svk-commit] r2740 - branches/path-resolver/lib/SVK

[nobody at bestpractical.com]

Author: ruz
Date: Sun Apr 20 22:43:51 2008
New Revision: 2740

Modified:
   branches/path-resolver/lib/SVK/Notify.pm

Log:
* add some docs

Modified: branches/path-resolver/lib/SVK/Notify.pm
==============================================================================
--- branches/path-resolver/lib/SVK/Notify.pm	(original)
+++ branches/path-resolver/lib/SVK/Notify.pm	Sun Apr 20 22:43:51 2008
@@ -70,6 +70,24 @@
 
 =head1 DESCRIPTION
 
+Collect and report status of nodes in a tree.
+
+=head1 METHODS
+
+=head2 new
+
+=over 4
+
+=item cb_flush
+
+=item cb_skip
+
+=item quite - don't report anything if true.
+
+=item flush_baserev
+
+=back
+
 
 
 =cut
@@ -135,6 +153,15 @@
 		  cb_flush => print_report (\&flush_print, $is_copath, $report, $target));
 }
 
+=head2 notify_translate $translator
+
+Sets $translator as path converter. Should be code reference
+which modifies its first argument. For example:
+
+    $notify->notify_translate( sub { $_[0] =~ s/^path/new_path/ } );
+
+=cut
+
 sub notify_translate {
     my ($self, $translate) = @_;
 
@@ -148,6 +175,12 @@
     }
 }
 
+=head2 node_status $path [$status]
+
+Sets or returns status of the $path.
+
+=cut
+
 sub node_status {
     my ($self, $path, $s) = @_;
     Carp::cluck unless defined $path;