From: Guillermo Roditi Date: Sun, 24 Feb 2008 04:21:55 +0000 (+0000) Subject: just some docs and tiny changes X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=9afe15bd5b55cb870d540b09e213c8d5fb04e0f7;p=gitmo%2FMooseX-AutoDoc.git just some docs and tiny changes --- diff --git a/lib/MooseX/AutoDoc.pm b/lib/MooseX/AutoDoc.pm index dd88ab3..54b78c6 100644 --- a/lib/MooseX/AutoDoc.pm +++ b/lib/MooseX/AutoDoc.pm @@ -394,7 +394,7 @@ names and attempting to load and instantiate a class of the same name. =head1 METHODS -=head2 new $key => $value +=head2 new key => $value Instantiate a new object. Please refer to L for a list of valid key options. diff --git a/lib/MooseX/AutoDoc/View.pm b/lib/MooseX/AutoDoc/View.pm index 4c36ebf..8f516c7 100644 --- a/lib/MooseX/AutoDoc/View.pm +++ b/lib/MooseX/AutoDoc/View.pm @@ -9,3 +9,57 @@ sub render_role { confess "Unimplemented Method"; } sub render_class { confess "Unimplemented Method"; } 1; + +__END__; + +=head1 NAME + +MooseX::AutoDoc::View + +=head1 DESCRIPTION + +This is an empty base class for MooseX::AutoDoc views. + +=head1 ATTRIBUTES + +=head2 args + +=over 4 + +=item B - has_args + +=back + +Optional read-only value. It's use is defined by the subclass. + +=head1 METHODS + +=head2 new key => $value + +Instantiate a new object. + +=head2 render_class \%vars, $options + +Render the documentation for a class. By default, AutoDoc will pass three +variables, authors, class, license. + +=head2 render_role \%vars, $options + +Render the documentation for a role. By default, AutoDoc will pass three +variables, authors, class, license. + +=head2 meta + +Retrieve the metaclass instance. Please see L and +L for more information. + +=head1 AUTHORS + +Guillermo Roditi (groditi) + +=head1 COPYRIGHT AND LICENSE + +This library is free software; you can redistribute it and/or modify it under +the same terms as Perl itself. + +=cut diff --git a/lib/MooseX/AutoDoc/View/TT.pm b/lib/MooseX/AutoDoc/View/TT.pm index 0145be8..1c4efb4 100644 --- a/lib/MooseX/AutoDoc/View/TT.pm +++ b/lib/MooseX/AutoDoc/View/TT.pm @@ -1,5 +1,10 @@ package MooseX::AutoDoc::View::TT; +#TODO: +# Versions +# POD block for RT / Bugs / etc +# MooseX::Methods support + use Moose; use Scalar::Util qw/blessed/; use Template; @@ -154,7 +159,7 @@ END; $blocks->{methods_block} = q^ =head1 METHODS -=head2 new $key => $value +=head2 new key => $value Instantiate a new object. Please refer to L for a list of valid key options.