Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Simple::PullParserEndToken.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Pod::Simple::PullParserEndToken 3pm"
61 .TH Pod::Simple::PullParserEndToken 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Pod::Simple::PullParserEndToken \-\- end\-tokens from Pod::Simple::PullParser
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 (See Pod::Simple::PullParser)
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 When you do \f(CW$parser\fR\->get_token on a Pod::Simple::PullParser, you might
74 get an object of this class.
75 .PP
76 This is a subclass of Pod::Simple::PullParserToken and inherits all its methods,
77 and adds these methods:
78 .ie n .IP $token\->tagname 4
79 .el .IP \f(CW$token\fR\->tagname 4
80 .IX Item "$token->tagname"
81 This returns the tagname for this end\-token object.
82 For example, parsing a "=head1 ..." line will give you
83 a start\-token with the tagname of "head1", token(s) for its
84 content, and then an end\-token with the tagname of "head1".
85 .ie n .IP $token\->tagname(\fIsomestring\fR) 4
86 .el .IP \f(CW$token\fR\->tagname(\fIsomestring\fR) 4
87 .IX Item "$token->tagname(somestring)"
88 This changes the tagname for this end\-token object.
89 You probably won\*(Aqt need to do this.
90 .ie n .IP $token\->tag(...) 4
91 .el .IP \f(CW$token\fR\->tag(...) 4
92 .IX Item "$token->tag(...)"
93 A shortcut for \f(CW$token\fR\->tagname(...)
94 .ie n .IP "$token\->is_tag(\fIsomestring\fR) or $token\->is_tagname(\fIsomestring\fR)" 4
95 .el .IP "\f(CW$token\fR\->is_tag(\fIsomestring\fR) or \f(CW$token\fR\->is_tagname(\fIsomestring\fR)" 4
96 .IX Item "$token->is_tag(somestring) or $token->is_tagname(somestring)"
97 These are shortcuts for \f(CW\*(C`$token\->tag() eq \fR\f(CIsomestring\fR\f(CW\*(C'\fR
98 .PP
99 You\*(Aqre unlikely to ever need to construct an object of this class for
100 yourself, but if you want to, call
101 \&\f(CW\*(C`Pod::Simple::PullParserEndToken\->new( \fR\f(CItagname\fR\f(CW )\*(C'\fR
102 .SH "SEE ALSO"
103 .IX Header "SEE ALSO"
104 Pod::Simple::PullParserToken, Pod::Simple, Pod::Simple::Subclassing
105 .SH SUPPORT
106 .IX Header "SUPPORT"
107 Questions or discussion about POD and Pod::Simple should be sent to the
108 pod\[email protected] mail list. Send an empty email to
109 pod\-people\[email protected] to subscribe.
110 .PP
111 This module is managed in an open GitHub repository,
112 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
113 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
114 .PP
115 Patches against Pod::Simple are welcome. Please send bug reports to
116 <bug\-pod\[email protected]>.
117 .SH "COPYRIGHT AND DISCLAIMERS"
118 .IX Header "COPYRIGHT AND DISCLAIMERS"
119 Copyright (c) 2002 Sean M. Burke.
120 .PP
121 This library is free software; you can redistribute it and/or modify it
122 under the same terms as Perl itself.
123 .PP
124 This program is distributed in the hope that it will be useful, but
125 without any warranty; without even the implied warranty of
126 merchantability or fitness for a particular purpose.
127 .SH AUTHOR
128 .IX Header "AUTHOR"
129 Pod::Simple was created by Sean M. Burke <[email protected]>.
130 But don\*(Aqt bother him, he\*(Aqs retired.
131 .PP
132 Pod::Simple is maintained by:
133 .IP \(bu 4
134 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
135 .IP \(bu 4
136 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
137 .IP \(bu 4
138 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR