|
BASIS
r3148
|
Over.pm
Go to the documentation of this file.
00001 #============================================================= -*-Perl-*- 00002 # 00003 # Pod::POM::Node::Over 00004 # 00005 # DESCRIPTION 00006 # Module implementing specific nodes in a Pod::POM, subclassed from 00007 # Pod::POM::Node. 00008 # 00009 # AUTHOR 00010 # Andy Wardley <abw@kfs.org> 00011 # Andrew Ford <a.ford@ford-mason.co.uk> 00012 # 00013 # COPYRIGHT 00014 # Copyright (C) 2000, 2001 Andy Wardley. All Rights Reserved. 00015 # Copyright (C) 2009 Andrew Ford. All Rights Reserved. 00016 # 00017 # This module is free software; you can redistribute it and/or 00018 # modify it under the same terms as Perl itself. 00019 # 00020 # REVISION 00021 # $Id: Over.pm 76 2009-08-20 20:41:33Z ford $ 00022 # 00023 #======================================================================== 00024 00025 package BASIS::Pod::POM::Node::Over; 00026 00027 use strict; 00028 00029 use parent qw( BASIS::Pod::POM::Node ); 00030 use vars qw( %ATTRIBS @ACCEPT $EXPECT $ERROR ); 00031 00032 %ATTRIBS = ( indent => 4 ); 00033 @ACCEPT = qw( over item begin for text verbatim code ); 00034 $EXPECT = 'back'; 00035 00036 sub list_type { 00037 my $self = shift; 00038 my ($first, @rest) = $self->content; 00039 00040 my $first_type = $first->type; 00041 return; 00042 } 00043 00044 00045 1; 00046 00047 =head1 NAME 00048 00049 Pod::POM::Node::Over - POM '=over' node class 00050 00051 =head1 SYNOPSIS 00052 00053 use Pod::POM::Nodes; 00054 00055 =head1 DESCRIPTION 00056 00057 This class implements '=over' Pod nodes. As described by the L<perlpodspec> man page =over/=back regions are 00058 used for various kinds of list-like structures (including blockquote paragraphs). 00059 00060 =item 1. 00061 00062 ordered list 00063 00064 =item * 00065 00066 text paragraph 00067 00068 unordered list 00069 00070 =item text 00071 00072 text paragraph 00073 00074 definition list 00075 00076 00077 00078 =head1 AUTHOR 00079 00080 Andrew Ford E<lt>a.ford@ford-mason.co.ukE<gt> 00081 00082 Andy Wardley E<lt>abw@kfs.orgE<gt> 00083 00084 =head1 COPYRIGHT 00085 00086 Copyright (C) 2000, 2001 Andy Wardley. All Rights Reserved. 00087 00088 Copyright (C) 2009 Andrew Ford. All Rights Reserved. 00089 00090 This module is free software; you can redistribute it and/or 00091 modify it under the same terms as Perl itself. 00092 00093 =head1 SEE ALSO 00094 00095 Consult L<Pod::POM::Node> for a discussion of nodes.