NAME

Pod::Weaver::Section::ClassMopper - Use Class::MOP introspection to make a couple sections.

OVERVIEW

This section plugin is able to generate two sections for you, ATTRIBUTES and METHODS. By default, only attributes are created.

Your results will look something like:

ATTRIBUTES

=head2 someattribute

Reader: someattribute

Type: Str

This attribute is required.

It should be noted that should an attribute make use of the Moose 'documentation' option, its value will be included here as well.

=head1 METHODS

=head2 somemethod
 
Method originates in Some::Parent::Class

This documentation was automatically generated.

=head2 another_method 

OPTIONS

All options are checked under the mopper part of the input..

$weaver->weave_document({ 
  ...
  mopper => { 
     include_private => 0,
     skip_attributes => 0,
     skip_methods => 0,
     no_tagline => 0,
     skip_method_list => { 
        # see below..
     }
  },
  ...
});

include_private

By default, all methods and attributes matching /^_/ are excluded. Toggle this bit on if you want to see the gory details.

skip_attributes and skip_methods

Set these to something Perl thinks is true and it'll skip over the appropriate section.

no_tagline

Turn the "This documentation was automatically generated" bit off. It's on by default.

skip_method_list

Provide a hashref here to provide the complete list of methods you would like to skip. At some point, you should probably just manually edit the docs, guys.

The default list of methods skipped is:

BUILDARGS

BUILDALL

DEMOLISHALL

does

DOES

dump

can

VERSION

DESTROY

AUTHOR

Dave Houston, dhouston@cpan.org, 2010.

LICENSE

This library is free software; you may redistribute and/or modify it under the same terms as Perl itself.