All unit tests passing with refactored stuff, documentation updated significantly.

[gitmo/MooseX-AttributeHelpers.git] / lib / MooseX / AttributeHelpers / MethodProvider / String.pm

diff --git a/lib/MooseX/AttributeHelpers/MethodProvider/String.pm b/lib/MooseX/AttributeHelpers/MethodProvider/String.pm
index 4e4ee82..98d981f 100644 (file)
--- a/lib/MooseX/AttributeHelpers/MethodProvider/String.pm
+++ b/lib/MooseX/AttributeHelpers/MethodProvider/String.pm
@@ -86,33 +86,48 @@ MooseX::AttributeHelpers::MethodProvider::String
 This is a role which provides the method generators for 
 L<MooseX::AttributeHelpers::String>.
 
-=head1 METHODS
+=head1 PROVIDED METHODS
+
+It should be noted that all methods modify attribute values in place.
 
 =over 4
 
-=item B<meta>
+=item I<inc>
 
-=back
+Increments the value stored in this slot using the magical string autoincrement
+operator. Note that Perl doesn't provide analogeous behavior in C<-->, so
+C<dec> is not available.
 
-=head1 PROVIDED METHODS
+=item I<append> C<$string>
 
-=over 4
+Append a string, like C<.=>.
+
+=item I<prepend> C<$string>
+
+Prepend a string.
+
+=item I<replace> C<$pattern> C<$replacement>
+
+Performs a regexp substitution (L<perlop/s>). There is no way to provide the
+C<g> flag, but code references will be accepted for the replacement, causing
+the regex to be modified with a single C<e>. C</smxi> can be applied using the
+C<qr> operator.
 
-=item B<append>
+=item I<match> C<$pattern>
 
-=item B<prepend>
+Like I<replace> but without the replacement. Provided mostly for completeness.
 
-=item B<replace>
+=item C<chop>
 
-=item B<match>
+L<perlfunc/chop>
 
-=item B<chomp>
+=item C<chomp>
 
-=item B<chop>
+L<perlfunc/chomp>
 
-=item B<inc>
+=item C<clear>
 
-=item B<clear>
+Sets the string to the empty string (not the value passed to C<default>).
 
 =back