Pod::Readme::Types (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Pod::Readme::Types.3pm".)

NAME

Pod::Readme::Types - Types used by Pod::Readme

SYNOPSIS

  use Pod::Readme::Types qw/ Indentation /;

  has verbatim_indent => (
    is      => 'ro',
    isa     => Indentation,
    default => 2,
  );

DESCRIPTION

This module provides types for use with the modules in Pod::Readme.

It is intended for internal use, although some of these may be useful for writing plugins (see Pod::Readme::Plugin).

EXPORTS

None by default. All functions must be explicitly exported.

Indentation

The indentation level used for verbatim text. Must be an integer greater than or equal to 2.

HeadingLevel

A heading level, used for plugin headings.

Must be either 1, 2 or 3. (Note that "=head4" is not allowed, since some plugins use subheadings.)

TargetName

A name of a target, e.g. ``readme''.

Dir

A directory. Can be a string or Path::Tiny object.

File

A file. Can be a string or Path::Tiny object.

IO

An IO::Handle or IO::String object.

ReadIO

WriteIO

`` types, which coerce filehandles to read/write <IO:Handles>, respectively.

DistZilla

A Dist::Zilla object.