Clarify licensing, ensure footers are consistent throughout the project
[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Admin / Usage.pm
index d3e16e5..d479ae5 100644 (file)
@@ -1,13 +1,13 @@
 package     # hide from PAUSE
     DBIx::Class::Admin::Usage;
 
+use warnings;
+use strict;
 
 use base 'Getopt::Long::Descriptive::Usage';
 
 use base 'Class::Accessor::Grouped';
 
-use Class::C3;
-
 __PACKAGE__->mk_group_accessors('simple', 'synopsis', 'short_description');
 
 sub prog_name {
@@ -22,16 +22,11 @@ sub set_simple {
 }
 
 
-=head2 pod
-
-This returns the usage formated as a pod document
-
-=cut
-
 
+# This returns the usage formatted as a pod document
 sub pod {
   my ($self) = @_;
-  return join qq{\n}, $self->pod_leader_text, $self->pod_option_text;
+  return join qq{\n}, $self->pod_leader_text, $self->pod_option_text, $self->pod_authorlic_text;
 }
 
 sub pod_leader_text {
@@ -42,6 +37,17 @@ sub pod_leader_text {
 
 }
 
+sub pod_authorlic_text {
+
+  return join ("\n\n",
+    '=head1 AUTHORS',
+    'See L<DBIx::Class/AUTHORS>',
+    '=head1 LICENSE',
+    'You may distribute this code under the same terms as Perl itself',
+    '=cut',
+  );
+}
+
 
 sub pod_option_text {
   my ($self) = @_;
@@ -54,6 +60,7 @@ sub pod_option_text {
   foreach my $opt (@options) {
     my $spec = $opt->{spec};
     my $desc = $opt->{desc};
+    next if ($desc eq 'hidden');
     if ($desc eq 'spacer') {
         $string .= "=back\n\n=head2 $spec\n\n=cut\n\n=over\n\n";
         next;
@@ -61,7 +68,7 @@ sub pod_option_text {
 
     $spec = Getopt::Long::Descriptive->_strip_assignment($spec);
     $string .= "=item " . join " or ", map { length > 1 ? "B<--$_>" : "B<-$_>" }
-                             split /\|/, $spec; 
+                             split /\|/, $spec;
     $string .= "\n\n$desc\n\n=cut\n\n";
 
   }