1Pod::Readme::Types(3) User Contributed Perl DocumentationPod::Readme::Types(3)
2
3
4

NAME

6       Pod::Readme::Types - Types used by Pod::Readme
7

SYNOPSIS

9         use Pod::Readme::Types qw/ Indentation /;
10
11         has verbatim_indent => (
12           is      => 'ro',
13           isa     => Indentation,
14           default => 2,
15         );
16

DESCRIPTION

18       This module provides types for use with the modules in Pod::Readme.
19
20       It is intended for internal use, although some of these may be useful
21       for writing plugins (see Pod::Readme::Plugin).
22

EXPORTS

24       None by default. All functions must be explicitly exported.
25
26   "Indentation"
27       The indentation level used for verbatim text. Must be an integer
28       greater than or equal to 2.
29
30   "HeadingLevel"
31       A heading level, used for plugin headings.
32
33       Must be either 1, 2 or 3. (Note that "=head4" is not allowed, since
34       some plugins use subheadings.)
35
36   "TargetName"
37       A name of a target, e.g. "readme".
38
39   "Dir"
40       A directory. Can be a string or Path::Tiny object.
41
42   "File"
43       A file. Can be a string or Path::Tiny object.
44
45   "IO"
46       An IO::Handle or IO::String object.
47
48   "ReadIO"
49   "WriteIO"
50       "IO" types, which coerce filehandles to read/write <IO:Handles>,
51       respectively.
52
53
54
55perl v5.34.0                      2022-01-21             Pod::Readme::Types(3)
Impressum