NAME

Dist::Zilla::Plugin::AlienBase::Doc - Generate boilerplate documentation for Alien::Base subclass

VERSION

version 0.31

SYNOPSIS

In your dist.ini:

 [AlienBase::Doc]
 name = libfoo

In your Alien/Foo.pm:

 package Alien::Foo;
 
 use strict;
 use warnings;
 use base qw( Alien::Base );
 
 # ALIEN SYNOPSIS
 # ALIEN DESCRIPTION
 # ALIEN SEE ALSO
 
 1;

DESCRIPTION

This plugin generates some boiler plat documentation for your Alien::Base based Alien module. It will find the special codes ALIEN SYNOPSIS, ALIEN DESCRIPTION, and ALIEN SEE ALSO and replace them with the appropriate boilerplate POD documentation for how to use the module. The generated synopsis and see also sections are probably good enough as is. The description is a little more basic, and you may want to write a more detailed description yourself. It is, at least, better than nothing though!

ATTRIBUTES

class_name

The name of the Alien::Base subclass. The default is based on the distribution's main module.

min_version

The minimum version to suggest using as a prereq.

type

Types of the Alien. This can be specified multiple times. Valid types:

library
tool
ffi

see_also

List of modules to refer to in the SEE ALSO section. By default this is

Alien
Alien::Base
Alien::Build::Manual::AlienUser

AUTHOR

Graham Ollis <plicease@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Graham Ollis.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DESCRIPTION

This distribution provides {{ $name }} so that it can be used by other Perl distributions that are on CPAN. It does this by first trying to detect an existing install of {{ $name }} on your system. If found it will use that. If it cannot be found, the source code will be downloaded from the internet and it will be installed in a private share location for the use of other modules.