Commit | Line | Data |
3890b670 |
1 | package MooseX::AutoDoc::View; |
2 | |
3 | use Moose; |
4 | |
5 | has args => (is => 'ro', predicate => 'has_args'); |
6 | |
7 | #twi different methods because it really does make more sense this way |
8 | sub render_role { confess "Unimplemented Method"; } |
9 | sub render_class { confess "Unimplemented Method"; } |
10 | |
11 | 1; |
9afe15bd |
12 | |
13 | __END__; |
14 | |
15 | =head1 NAME |
16 | |
17 | MooseX::AutoDoc::View |
18 | |
19 | =head1 DESCRIPTION |
20 | |
21 | This is an empty base class for MooseX::AutoDoc views. |
22 | |
23 | =head1 ATTRIBUTES |
24 | |
25 | =head2 args |
26 | |
27 | =over 4 |
28 | |
29 | =item B<predicate> - has_args |
30 | |
31 | =back |
32 | |
33 | Optional read-only value. It's use is defined by the subclass. |
34 | |
35 | =head1 METHODS |
36 | |
37 | =head2 new key => $value |
38 | |
39 | Instantiate a new object. |
40 | |
41 | =head2 render_class \%vars, $options |
42 | |
43 | Render the documentation for a class. By default, AutoDoc will pass three |
44 | variables, authors, class, license. |
45 | |
46 | =head2 render_role \%vars, $options |
47 | |
48 | Render the documentation for a role. By default, AutoDoc will pass three |
49 | variables, authors, class, license. |
50 | |
51 | =head2 meta |
52 | |
53 | Retrieve the metaclass instance. Please see L<Moose::Meta::Class> and |
54 | L<Class::MOP::Class> for more information. |
55 | |
56 | =head1 AUTHORS |
57 | |
58 | Guillermo Roditi (groditi) <groditi@cpan.org> |
59 | |
60 | =head1 COPYRIGHT AND LICENSE |
61 | |
62 | This library is free software; you can redistribute it and/or modify it under |
63 | the same terms as Perl itself. |
64 | |
65 | =cut |