Head1.pm
Go to the documentation of this file.
1 #============================================================= -*-Perl-*-
2 #
3 # Pod::POM::Node::Head1
4 #
5 # DESCRIPTION
6 # Module implementing specific nodes in a Pod::POM, subclassed from
7 # Pod::POM::Node.
8 #
9 # AUTHOR
10 # Andy Wardley <abw@kfs.org>
11 # Andrew Ford <a.ford@ford-mason.co.uk>
12 #
13 # COPYRIGHT
14 # Copyright (C) 2000, 2001 Andy Wardley. All Rights Reserved.
15 # Copyright (C) 2009 Andrew Ford. All Rights Reserved.
16 #
17 # This module is free software; you can redistribute it and/or
18 # modify it under the same terms as Perl itself.
19 #
20 # REVISION
21 # $Id: Head1.pm 76 2009-08-20 20:41:33Z ford $
22 #
23 #========================================================================
24 
25 package BASIS::Pod::POM::Node::Head1;
26 
27 use strict;
28 
29 use parent qw( BASIS::Pod::POM::Node );
30 use vars qw( %ATTRIBS @ACCEPT $ERROR );
31 
32 %ATTRIBS = ( title => undef );
33 @ACCEPT = qw( head2 head3 head4 over begin for text verbatim code );
34 
35 sub new {
36  my ($class, $pom, $title) = @_;
37  $title = $pom->parse_sequence($title)
38  || return $class->error($pom->error())
39  if length $title;
40  return $class->SUPER::new($pom, $title);
41 }
42 
43 1;
44 
45 =head1 NAME
46 
47 Pod::POM::Node::Head1 -
48 
49 =head1 SYNOPSIS
50 
51  use Pod::POM::Nodes;
52 
53 =head1 DESCRIPTION
54 
55 This module implements a specialization of the node class to represent C<=head1> elements.
56 
57 =head1 AUTHOR
58 
59 Andrew Ford E<lt>a.ford@ford-mason.co.ukE<gt>
60 
61 Andy Wardley E<lt>abw@kfs.orgE<gt>
62 
63 =head1 COPYRIGHT
64 
65 Copyright (C) 2000, 2001 Andy Wardley. All Rights Reserved.
66 
67 Copyright (C) 2009 Andrew Ford. All Rights Reserved.
68 
69 This module is free software; you can redistribute it and/or
70 modify it under the same terms as Perl itself.
71 
72 =head1 SEE ALSO
73 
74 Consult L<Pod::POM::Node> for a discussion of nodes.