From: Rafael Kitover <rkitover@cpan.org>
Date: Thu, 21 Jan 2010 22:39:52 +0000 (+0000)
Subject: update pod_comment_mode POD
X-Git-Tag: 0.05000~17
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=34896b5e6b3ee330384cb389161393dd7674528e;p=dbsrgits%2FDBIx-Class-Schema-Loader.git

update pod_comment_mode POD
---

diff --git a/lib/DBIx/Class/Schema/Loader/Base.pm b/lib/DBIx/Class/Schema/Loader/Base.pm
index 2b85011..39431fa 100644
--- a/lib/DBIx/Class/Schema/Loader/Base.pm
+++ b/lib/DBIx/Class/Schema/Loader/Base.pm
@@ -179,9 +179,22 @@ force a C<DESCRIPTION> section to be generated with the comment instead, or
 choose the length threshold at which the comment is forced into the
 description.
 
-  pod_comment_mode => 'name' # default behaviour
-  pod_comment_mode => 'description' # force creation of DESCRIPTION section
-  pod_comment_mode => 'auto' # use description if length > pod_comment_spillover_length
+=over 4
+
+=item name
+
+Use C<NAME> section only.
+
+=item description
+
+Force C<DESCRIPTION> always.
+
+=item auto
+
+Use C<DESCRIPTION> if length > L</pod_comment_spillover_length>, this is the
+default.
+
+=back
 
 =head2 pod_comment_spillover_length