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, both sections are generated.

Your results will look something like:

 =head1 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 => { 
         [qw(DOES AUTOLOAD can)] # .. see below
      }
   },
   ...
 });

Additionally, options passed via weaver.ini, by the same name, should also be accepted.

 [ClassMopper]
 no_tagline = 1
 skip_method_list = DOES AUTOLOAD can  
etc.

include_private

   By default, all methods and attributes matching C</^_/> 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

By default, there are several methods (see below) that will be skipped when generating your list. Most of them are from UNIVERSAL or Moose::Object. If you'd like to adjust this list, provide the complete list (that is, include the things below, and then some) here, as an arrayref.

The default list of methods skipped is derived from Moose::Object's list of methods. At the time of writing, that list is:

dump

DEMOLISHALL

meta

does

new

DESTROY

BUILDALL

can

BUILDARGS

isa

VERSION

DOES

AUTHOR

Dave Houston, dhouston@cpan.org, 2010.

CONTRIBUTORS

Alexei Znamensky <russoz@cpan.org>

Caleb Cushing <xenoterracide@gmail.com>

Edward Ash <eash@nvidia.com>

LICENSE

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