Debian Codegraph @

upstream/debian-unstable/man3/Pod::Simple::PullParserEndToken.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Pod::Simple::PullParserEndToken 3perl"
58 .TH Pod::Simple::PullParserEndToken 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Pod::Simple::PullParserEndToken \-\- end\-tokens from Pod::Simple::PullParser
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 (See Pod::Simple::PullParser)
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 When you do \f(CW$parser\fR\->get_token on a Pod::Simple::PullParser, you might
71 get an object of this class.
72 .PP
73 This is a subclass of Pod::Simple::PullParserToken and inherits all its methods,
74 and adds these methods:
75 .ie n .IP $token\->tagname 4
76 .el .IP \f(CW$token\fR\->tagname 4
77 .IX Item "$token->tagname"
78 This returns the tagname for this end-token object.
79 For example, parsing a "=head1 ..." line will give you
80 a start-token with the tagname of "head1", token(s) for its
81 content, and then an end-token with the tagname of "head1".
82 .ie n .IP $token\->tagname(\fIsomestring\fR) 4
83 .el .IP \f(CW$token\fR\->tagname(\fIsomestring\fR) 4
84 .IX Item "$token->tagname(somestring)"
85 This changes the tagname for this end-token object.
86 You probably won't need to do this.
87 .ie n .IP $token\->tag(...) 4
88 .el .IP \f(CW$token\fR\->tag(...) 4
89 .IX Item "$token->tag(...)"
90 A shortcut for \f(CW$token\fR\->tagname(...)
91 .ie n .IP "$token\->is_tag(\fIsomestring\fR) or $token\->is_tagname(\fIsomestring\fR)" 4
92 .el .IP "\f(CW$token\fR\->is_tag(\fIsomestring\fR) or \f(CW$token\fR\->is_tagname(\fIsomestring\fR)" 4
93 .IX Item "$token->is_tag(somestring) or $token->is_tagname(somestring)"
94 These are shortcuts for \f(CW\*(C`$token\->tag() eq \fR\f(CIsomestring\fR\f(CW\*(C'\fR
95 .PP
96 You're unlikely to ever need to construct an object of this class for
97 yourself, but if you want to, call
98 \&\f(CW\*(C`Pod::Simple::PullParserEndToken\->new( \fR\f(CItagname\fR\f(CW )\*(C'\fR
99 .SH "SEE ALSO"
100 .IX Header "SEE ALSO"
101 Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing
102 .SH SUPPORT
103 .IX Header "SUPPORT"
104 Questions or discussion about POD and Pod::Simple should be sent to the
105 pod\[email protected] mail list. Send an empty email to
106 pod\-people\[email protected] to subscribe.
107 .PP
108 This module is managed in an open GitHub repository,
109 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
110 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
111 .PP
112 Patches against Pod::Simple are welcome. Please send bug reports to
113 <bug\-pod\[email protected]>.
114 .SH "COPYRIGHT AND DISCLAIMERS"
115 .IX Header "COPYRIGHT AND DISCLAIMERS"
116 Copyright (c) 2002 Sean M. Burke.
117 .PP
118 This library is free software; you can redistribute it and/or modify it
119 under the same terms as Perl itself.
120 .PP
121 This program is distributed in the hope that it will be useful, but
122 without any warranty; without even the implied warranty of
123 merchantability or fitness for a particular purpose.
124 .SH AUTHOR
125 .IX Header "AUTHOR"
126 Pod::Simple was created by Sean M. Burke <[email protected]>.
127 But don't bother him, he's retired.
128 .PP
129 Pod::Simple is maintained by:
130 .IP \(bu 4
131 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
132 .IP \(bu 4
133 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
134 .IP \(bu 4
135 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR