Debian Codegraph @

upstream/mageia-cauldron/man3pm/Pod::Checker.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::Checker 3pm"
61 .TH Pod::Checker 3pm 2024-05-07 "perl v5.42.0" "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::Checker \- check pod documents for syntax errors
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use Pod::Checker;
72 \&
73 \& $syntax_okay = podchecker($filepath, $outputpath, %options);
74 \&
75 \& my $checker = Pod::Checker\->new(%options);
76 \& $checker\->parse_from_file($filepath, \e*STDERR);
77 .Ve
78 .SH OPTIONS/ARGUMENTS
79 .IX Header "OPTIONS/ARGUMENTS"
80 \&\f(CW$filepath\fR is the input POD to read and \f(CW$outputpath\fR is
81 where to write POD syntax error messages. Either argument may be a scalar
82 indicating a file\-path, or else a reference to an open filehandle.
83 If unspecified, the input\-file it defaults to \f(CW\*(C`\e*STDIN\*(C'\fR, and
84 the output\-file defaults to \f(CW\*(C`\e*STDERR\*(C'\fR.
85 .SS \fBpodchecker()\fP
86 .IX Subsection "podchecker()"
87 This function can take a hash of options:
88 .IP "\fB\-warnings\fR => \fIval\fR" 4
89 .IX Item "-warnings => val"
90 Turn warnings on/off. \fIval\fR is usually 1 for on, but higher values
91 trigger additional warnings. See "Warnings".
92 .IP "\fB\-quiet\fR => \fIval\fR" 4
93 .IX Item "-quiet => val"
94 If \f(CW\*(C`val\*(C'\fR is true, do not print any errors/warnings.
95 .SH DESCRIPTION
96 .IX Header "DESCRIPTION"
97 \&\fBpodchecker\fR will perform syntax checking of Perl5 POD format documentation.
98 .PP
99 Curious/ambitious users are welcome to propose additional features they wish
100 to see in \fBPod::Checker\fR and \fBpodchecker\fR and verify that the checks are
101 consistent with perlpod.
102 .PP
103 The following checks are currently performed:
104 .IP \(bu 4
105 Unknown \*(Aq=xxxx\*(Aq commands, unknown \*(AqX<...>\*(Aq interior\-sequences,
106 and unterminated interior sequences.
107 .IP \(bu 4
108 Check for proper balancing of \f(CW\*(C`=begin\*(C'\fR and \f(CW\*(C`=end\*(C'\fR. The contents of such
109 a block are generally ignored, i.e. no syntax checks are performed.
110 .IP \(bu 4
111 Check for proper nesting and balancing of \f(CW\*(C`=over\*(C'\fR, \f(CW\*(C`=item\*(C'\fR and \f(CW\*(C`=back\*(C'\fR.
112 .IP \(bu 4
113 Check for same nested interior\-sequences (e.g.
114 \&\f(CW\*(C`L<...L<...>...>\*(C'\fR).
115 .IP \(bu 4
116 Check for malformed or non\-existing entities \f(CW\*(C`E<...>\*(C'\fR.
117 .IP \(bu 4
118 Check for correct syntax of hyperlinks \f(CW\*(C`L<...>\*(C'\fR. See perlpod
119 for details.
120 .IP \(bu 4
121 Check for unresolved document\-internal links. This check may also reveal
122 misspelled links that seem to be internal links but should be links
123 to something else.
124 .SH DIAGNOSTICS
125 .IX Header "DIAGNOSTICS"
126 .SS Errors
127 .IX Subsection "Errors"
128 .IP \(bu 4
129 empty =headn
130 .Sp
131 A heading (\f(CW\*(C`=head1\*(C'\fR or \f(CW\*(C`=head2\*(C'\fR) without any text? That ain\*(Aqt no
132 heading!
133 .IP \(bu 4
134 =over on line \fIN\fR without closing =back
135 .IP \(bu 4
136 You forgot a \*(Aq=back\*(Aq before \*(Aq=head\fIN\fR\*(Aq
137 .IP \(bu 4
138 =over is the last thing in the document?!
139 .Sp
140 The \f(CW\*(C`=over\*(C'\fR command does not have a corresponding \f(CW\*(C`=back\*(C'\fR before the
141 next heading (\f(CW\*(C`=head1\*(C'\fR or \f(CW\*(C`=head2\*(C'\fR) or the end of the file.
142 .IP \(bu 4
143 \&\*(Aq=item\*(Aq outside of any \*(Aq=over\*(Aq
144 .IP \(bu 4
145 =back without =over
146 .Sp
147 An \f(CW\*(C`=item\*(C'\fR or \f(CW\*(C`=back\*(C'\fR command has been found outside a
148 \&\f(CW\*(C`=over\*(C'\fR/\f(CW\*(C`=back\*(C'\fR block.
149 .IP \(bu 4
150 Can\*(Aqt have a 0 in =over \fIN\fR
151 .Sp
152 You need to indent a strictly positive number of spaces, not 0.
153 .IP \(bu 4
154 =over should be: \*(Aq=over\*(Aq or \*(Aq=over positive_number\*(Aq
155 .Sp
156 Either have an argumentless =over, or have its argument a strictly positive number.
157 .IP \(bu 4
158 =begin \fITARGET\fR without matching =end \fITARGET\fR
159 .Sp
160 A \f(CW\*(C`=begin\*(C'\fR command was found that has no matching =end command.
161 .IP \(bu 4
162 =begin without a target?
163 .Sp
164 A \f(CW\*(C`=begin\*(C'\fR command was found that is not followed by the formatter
165 specification.
166 .IP \(bu 4
167 =end \fITARGET\fR without matching =begin.
168 .Sp
169 A standalone \f(CW\*(C`=end\*(C'\fR command was found.
170 .IP \(bu 4
171 \&\*(Aq=end\*(Aq without a target?
172 .Sp
173 \&\*(Aq=end\*(Aq directives need to have a target, just like =begin directives.
174 .IP \(bu 4
175 \&\*(Aq=end \fITARGET\fR\*(Aq is invalid.
176 .Sp
177 \&\fITARGET\fR needs to be one word
178 .IP \(bu 4
179 =end \fICONTENT\fR doesn\*(Aqt match =begin \fITARGET\fR
180 .Sp
181 \&\fICONTENT\fR needs to match =begin\*(Aqs \fITARGET\fR.
182 .IP \(bu 4
183 =for without a target?
184 .Sp
185 There is no specification of the formatter after the \f(CW\*(C`=for\*(C'\fR command.
186 .IP \(bu 4
187 unresolved internal link \fINAME\fR
188 .Sp
189 The given link to \fINAME\fR does not have a matching node in the current
190 POD. This also happened when a single word node name is not enclosed in
191 \&\f(CW""\fR.
192 .IP \(bu 4
193 Unknown directive: \fICMD\fR
194 .Sp
195 An invalid POD command has been found. Valid are \f(CW\*(C`=head1\*(C'\fR, \f(CW\*(C`=head2\*(C'\fR,
196 \&\f(CW\*(C`=head3\*(C'\fR, \f(CW\*(C`=head4\*(C'\fR, \f(CW\*(C`=over\*(C'\fR, \f(CW\*(C`=item\*(C'\fR, \f(CW\*(C`=back\*(C'\fR, \f(CW\*(C`=begin\*(C'\fR, \f(CW\*(C`=end\*(C'\fR,
197 \&\f(CW\*(C`=for\*(C'\fR, \f(CW\*(C`=pod\*(C'\fR, \f(CW\*(C`=cut\*(C'\fR
198 .IP \(bu 4
199 Deleting unknown formatting code \fISEQ\fR
200 .Sp
201 An invalid markup command has been encountered. Valid are:
202 \&\f(CW\*(C`B<>\*(C'\fR, \f(CW\*(C`C<>\*(C'\fR, \f(CW\*(C`E<>\*(C'\fR, \f(CW\*(C`F<>\*(C'\fR,
203 \&\f(CW\*(C`I<>\*(C'\fR, \f(CW\*(C`L<>\*(C'\fR, \f(CW\*(C`S<>\*(C'\fR, \f(CW\*(C`X<>\*(C'\fR,
204 \&\f(CW\*(C`Z<>\*(C'\fR
205 .IP \(bu 4
206 Unterminated \fISEQ\fR<> sequence
207 .Sp
208 An unclosed formatting code
209 .IP \(bu 4
210 An E<...> surrounding strange content
211 .Sp
212 The \fISTRING\fR found cannot be interpreted as a character entity.
213 .IP \(bu 4
214 An empty E<>
215 .IP \(bu 4
216 An empty \f(CW\*(C`L<>\*(C'\fR
217 .IP \(bu 4
218 An empty X<>
219 .Sp
220 There needs to be content inside E, L, and X formatting codes.
221 .IP \(bu 4
222 Spurious text after =pod / =cut
223 .Sp
224 The commands \f(CW\*(C`=pod\*(C'\fR and \f(CW\*(C`=cut\*(C'\fR do not take any arguments.
225 .IP \(bu 4
226 =back doesn\*(Aqt take any parameters, but you said =back \fIARGUMENT\fR
227 .Sp
228 The \f(CW\*(C`=back\*(C'\fR command does not take any arguments.
229 .IP \(bu 4
230 =pod directives shouldn\*(Aqt be over one line long! Ignoring all \fIN\fR lines of content
231 .Sp
232 Self explanatory
233 .IP \(bu 4
234 =cut found outside a pod block.
235 .Sp
236 A \*(Aq=cut\*(Aq directive found in the middle of non\-POD
237 .IP \(bu 4
238 Invalid =encoding syntax: \fICONTENT\fR
239 .Sp
240 Syntax error in =encoding directive
241 .SS Warnings
242 .IX Subsection "Warnings"
243 These may not necessarily cause trouble, but indicate mediocre style.
244 .IP \(bu 4
245 nested commands \fICMD\fR<...\fICMD\fR<...>...>
246 .Sp
247 Two nested identical markup commands have been found. Generally this
248 does not make sense.
249 .IP \(bu 4
250 multiple occurrences (\fIN\fR) of link target \fIname\fR
251 .Sp
252 The POD file has some \f(CW\*(C`=item\*(C'\fR and/or \f(CW\*(C`=head\*(C'\fR commands that have
253 the same text. Potential hyperlinks to such a text cannot be unique then.
254 This warning is printed only with warning level greater than one.
255 .IP \(bu 4
256 line containing nothing but whitespace in paragraph
257 .Sp
258 There is some whitespace on a seemingly empty line. POD is very sensitive
259 to such things, so this is flagged. \fBvi\fR users switch on the \fBlist\fR
260 option to avoid this problem.
261 .IP \(bu 4
262 =item has no contents
263 .Sp
264 There is a list \f(CW\*(C`=item\*(C'\fR that has no text contents. You probably want to delete
265 empty items.
266 .IP \(bu 4
267 You can\*(Aqt have =items (as at line \fIN\fR) unless the first thing after the =over is an =item
268 .Sp
269 A list introduced by \f(CW\*(C`=over\*(C'\fR starts with a text or verbatim paragraph,
270 but continues with \f(CW\*(C`=item\*(C'\fRs. Move the non\-item paragraph out of the
271 \&\f(CW\*(C`=over\*(C'\fR/\f(CW\*(C`=back\*(C'\fR block.
272 .IP \(bu 4
273 Expected \*(Aq=item \fIEXPECTED VALUE\fR\*(Aq
274 .IP \(bu 4
275 Expected \*(Aq=item *\*(Aq
276 .IP \(bu 4
277 Possible =item type mismatch: \*(Aq\fIx\fR\*(Aq found leading a supposed definition =item
278 .Sp
279 A list started with e.g. a bullet\-like \f(CW\*(C`=item\*(C'\fR and continued with a
280 numbered one. This is obviously inconsistent. For most translators the
281 type of the \fIfirst\fR \f(CW\*(C`=item\*(C'\fR determines the type of the list.
282 .IP \(bu 4
283 You have \*(Aq=item x\*(Aq instead of the expected \*(Aq=item \fIN\fR\*(Aq
284 .Sp
285 Erroneous numbering of =item numbers; they need to ascend consecutively.
286 .IP \(bu 4
287 Unknown E content in E<\fICONTENT\fR>
288 .Sp
289 A character entity was found that does not belong to the standard
290 ISO set or the POD specials \f(CW\*(C`verbar\*(C'\fR and \f(CW\*(C`sol\*(C'\fR. \fICurrently, this warning
291 only appears if a character entity was found that does not have a Unicode
292 character. This should be fixed to adhere to the original warning.\fR
293 .IP \(bu 4
294 empty =over/=back block
295 .Sp
296 The list opened with \f(CW\*(C`=over\*(C'\fR does not contain anything.
297 .IP \(bu 4
298 empty section in previous paragraph
299 .Sp
300 The previous section (introduced by a \f(CW\*(C`=head\*(C'\fR command) does not contain
301 any valid content. This usually indicates that something is missing. Note: A
302 \&\f(CW\*(C`=head1\*(C'\fR followed immediately by \f(CW\*(C`=head2\*(C'\fR does not trigger this warning.
303 .IP \(bu 4
304 Verbatim paragraph in NAME section
305 .Sp
306 The NAME section (\f(CW\*(C`=head1 NAME\*(C'\fR) should consist of a single paragraph
307 with the script/module name, followed by a dash \`\-\*(Aq and a very short
308 description of what the thing is good for.
309 .IP \(bu 4
310 =head\fIn\fR without preceding higher level
311 .Sp
312 For example if there is a \f(CW\*(C`=head2\*(C'\fR in the POD file prior to a
313 \&\f(CW\*(C`=head1\*(C'\fR.
314 .IP \(bu 4
315 A non\-empty Z<>
316 .Sp
317 The \f(CW\*(C`Z<>\*(C'\fR sequence is supposed to be empty. Caveat: this issue is
318 detected in Pod::Simple and will be flagged as an \fIERROR\fR by any client
319 code; any contents of \f(CW\*(C`Z<...>\*(C'\fR will be disregarded, anyway.
320 .SS Hyperlinks
321 .IX Subsection "Hyperlinks"
322 There are some warnings with respect to malformed hyperlinks:
323 .IP \(bu 4
324 ignoring leading/trailing whitespace in link
325 .Sp
326 There is whitespace at the beginning or the end of the contents of
327 L<...>.
328 .IP \(bu 4
329 alternative text/node \*(Aq%s\*(Aq contains non\-escaped | or /
330 .Sp
331 The characters \f(CW\*(C`|\*(C'\fR and \f(CW\*(C`/\*(C'\fR are special in the L<...> context.
332 Although the hyperlink parser does its best to determine which "/" is
333 text and which is a delimiter in case of doubt, one ought to escape
334 these literal characters like this:
335 .Sp
336 .Vb 2
337 \& / E<sol>
338 \& | E<verbar>
339 .Ve
340 .PP
341 Note that the line number of the error/warning may refer to the line number of
342 the start of the paragraph in which the error/warning exists, not the line
343 number that the error/warning is on. This bug is present in errors/warnings
344 related to formatting codes. \fIThis should be fixed.\fR
345 .SH "RETURN VALUE"
346 .IX Header "RETURN VALUE"
347 \&\fBpodchecker\fR returns the number of POD syntax errors found or \-1 if
348 there were no POD commands at all found in the file.
349 .SH EXAMPLES
350 .IX Header "EXAMPLES"
351 See "SYNOPSIS"
352 .SH SCRIPTS
353 .IX Header "SCRIPTS"
354 The \fBpodchecker\fR script that comes with this distribution is a lean wrapper
355 around this module. See the online manual with
356 .PP
357 .Vb 2
358 \& podchecker \-help
359 \& podchecker \-man
360 .Ve
361 .SH INTERFACE
362 .IX Header "INTERFACE"
363 While checking, this module collects document properties, e.g. the nodes
364 for hyperlinks (\f(CW\*(C`=headX\*(C'\fR, \f(CW\*(C`=item\*(C'\fR) and index entries (\f(CW\*(C`X<>\*(C'\fR).
365 POD translators can use this feature to syntax\-check and get the nodes in
366 a first pass before actually starting to convert. This is expensive in terms
367 of execution time, but allows for very robust conversions.
368 .PP
369 Since v1.24 the \fBPod::Checker\fR module uses only the \fBpoderror\fR
370 method to print errors and warnings. The summary output (e.g.
371 "Pod syntax OK") has been dropped from the module and has been included in
372 \&\fBpodchecker\fR (the script). This allows users of \fBPod::Checker\fR to
373 control completely the output behavior. Users of \fBpodchecker\fR (the script)
374 get the well\-known behavior.
375 .PP
376 v1.45 inherits from Pod::Simple as opposed to all previous versions
377 inheriting from Pod::Parser. Do \fBnot\fR use Pod::Simple\*(Aqs interface when
378 using Pod::Checker unless it is documented somewhere on this page. I
379 repeat, DO \fBNOT\fR USE POD::SIMPLE\*(AqS INTERFACE.
380 .PP
381 The following list documents the overrides to Pod::Simple, primarily to
382 make Pod::Coverage happy:
383 .IP end_B 4
384 .IX Item "end_B"
385 .PD 0
386 .IP end_C 4
387 .IX Item "end_C"
388 .IP end_Document 4
389 .IX Item "end_Document"
390 .IP end_F 4
391 .IX Item "end_F"
392 .IP end_I 4
393 .IX Item "end_I"
394 .IP end_L 4
395 .IX Item "end_L"
396 .IP end_Para 4
397 .IX Item "end_Para"
398 .IP end_S 4
399 .IX Item "end_S"
400 .IP end_X 4
401 .IX Item "end_X"
402 .IP end_fcode 4
403 .IX Item "end_fcode"
404 .IP end_for 4
405 .IX Item "end_for"
406 .IP end_head 4
407 .IX Item "end_head"
408 .IP end_head1 4
409 .IX Item "end_head1"
410 .IP end_head2 4
411 .IX Item "end_head2"
412 .IP end_head3 4
413 .IX Item "end_head3"
414 .IP end_head4 4
415 .IX Item "end_head4"
416 .IP end_item 4
417 .IX Item "end_item"
418 .IP end_item_bullet 4
419 .IX Item "end_item_bullet"
420 .IP end_item_number 4
421 .IX Item "end_item_number"
422 .IP end_item_text 4
423 .IX Item "end_item_text"
424 .IP handle_pod_and_cut 4
425 .IX Item "handle_pod_and_cut"
426 .IP handle_text 4
427 .IX Item "handle_text"
428 .IP handle_whiteline 4
429 .IX Item "handle_whiteline"
430 .IP hyperlink 4
431 .IX Item "hyperlink"
432 .IP scream 4
433 .IX Item "scream"
434 .IP start_B 4
435 .IX Item "start_B"
436 .IP start_C 4
437 .IX Item "start_C"
438 .IP start_Data 4
439 .IX Item "start_Data"
440 .IP start_F 4
441 .IX Item "start_F"
442 .IP start_I 4
443 .IX Item "start_I"
444 .IP start_L 4
445 .IX Item "start_L"
446 .IP start_Para 4
447 .IX Item "start_Para"
448 .IP start_S 4
449 .IX Item "start_S"
450 .IP start_Verbatim 4
451 .IX Item "start_Verbatim"
452 .IP start_X 4
453 .IX Item "start_X"
454 .IP start_fcode 4
455 .IX Item "start_fcode"
456 .IP start_for 4
457 .IX Item "start_for"
458 .IP start_head 4
459 .IX Item "start_head"
460 .IP start_head1 4
461 .IX Item "start_head1"
462 .IP start_head2 4
463 .IX Item "start_head2"
464 .IP start_head3 4
465 .IX Item "start_head3"
466 .IP start_head4 4
467 .IX Item "start_head4"
468 .IP start_item_bullet 4
469 .IX Item "start_item_bullet"
470 .IP start_item_number 4
471 .IX Item "start_item_number"
472 .IP start_item_text 4
473 .IX Item "start_item_text"
474 .IP start_over 4
475 .IX Item "start_over"
476 .IP start_over_block 4
477 .IX Item "start_over_block"
478 .IP start_over_bullet 4
479 .IX Item "start_over_bullet"
480 .IP start_over_empty 4
481 .IX Item "start_over_empty"
482 .IP start_over_number 4
483 .IX Item "start_over_number"
484 .IP start_over_text 4
485 .IX Item "start_over_text"
486 .IP whine 4
487 .IX Item "whine"
488 .PD
489 .ie n .IP """Pod::Checker\->new( %options )""" 4
490 .el .IP "\f(CWPod::Checker\->new( %options )\fR" 4
491 .IX Item "Pod::Checker->new( %options )"
492 Return a reference to a new Pod::Checker object that inherits from
493 Pod::Simple and is used for calling the required methods later. The
494 following options are recognized:
495 .Sp
496 \&\f(CW\*(C`\-warnings => num\*(C'\fR
497 Print warnings if \f(CW\*(C`num\*(C'\fR is true. The higher the value of \f(CW\*(C`num\*(C'\fR,
498 the more warnings are printed. Currently there are only levels 1 and 2.
499 .Sp
500 \&\f(CW\*(C`\-quiet => num\*(C'\fR
501 If \f(CW\*(C`num\*(C'\fR is true, do not print any errors/warnings. This is useful
502 when Pod::Checker is used to munge POD code into plain text from within
503 POD formatters.
504 .ie n .IP """$checker\->poderror( @args )""" 4
505 .el .IP "\f(CW$checker\->poderror( @args )\fR" 4
506 .IX Item "$checker->poderror( @args )"
507 .PD 0
508 .ie n .IP """$checker\->poderror( {%opts}, @args )""" 4
509 .el .IP "\f(CW$checker\->poderror( {%opts}, @args )\fR" 4
510 .IX Item "$checker->poderror( {%opts}, @args )"
511 .PD
512 Internal method for printing errors and warnings. If no options are given,
513 simply prints "@_". The following options are recognized and used to form
514 the output:
515 .Sp
516 .Vb 1
517 \& \-msg
518 .Ve
519 .Sp
520 A message to print prior to \f(CW@args\fR.
521 .Sp
522 .Vb 1
523 \& \-line
524 .Ve
525 .Sp
526 The line number the error occurred in.
527 .Sp
528 .Vb 1
529 \& \-file
530 .Ve
531 .Sp
532 The file (name) the error occurred in. Defaults to the name of the current
533 file being processed.
534 .Sp
535 .Vb 1
536 \& \-severity
537 .Ve
538 .Sp
539 The error level, should be \*(AqWARNING\*(Aq or \*(AqERROR\*(Aq.
540 .ie n .IP """$checker\->num_errors()""" 4
541 .el .IP \f(CW$checker\->num_errors()\fR 4
542 .IX Item "$checker->num_errors()"
543 Set (if argument specified) and retrieve the number of errors found.
544 .ie n .IP """$checker\->num_warnings()""" 4
545 .el .IP \f(CW$checker\->num_warnings()\fR 4
546 .IX Item "$checker->num_warnings()"
547 Set (if argument specified) and retrieve the number of warnings found.
548 .ie n .IP """$checker\->name()""" 4
549 .el .IP \f(CW$checker\->name()\fR 4
550 .IX Item "$checker->name()"
551 Set (if argument specified) and retrieve the canonical name of POD as
552 found in the \f(CW\*(C`=head1 NAME\*(C'\fR section.
553 .ie n .IP """$checker\->node()""" 4
554 .el .IP \f(CW$checker\->node()\fR 4
555 .IX Item "$checker->node()"
556 Add (if argument specified) and retrieve the nodes (as defined by \f(CW\*(C`=headX\*(C'\fR
557 and \f(CW\*(C`=item\*(C'\fR) of the current POD. The nodes are returned in the order of
558 their occurrence. They consist of plain text, each piece of whitespace is
559 collapsed to a single blank.
560 .ie n .IP """$checker\->idx()""" 4
561 .el .IP \f(CW$checker\->idx()\fR 4
562 .IX Item "$checker->idx()"
563 Add (if argument specified) and retrieve the index entries (as defined by
564 \&\f(CW\*(C`X<>\*(C'\fR) of the current POD. They consist of plain text, each piece
565 of whitespace is collapsed to a single blank.
566 .ie n .IP """$checker\->hyperlinks()""" 4
567 .el .IP \f(CW$checker\->hyperlinks()\fR 4
568 .IX Item "$checker->hyperlinks()"
569 Retrieve an array containing the hyperlinks to things outside
570 the current POD (as defined by \f(CW\*(C`L<>\*(C'\fR).
571 .Sp
572 Each is an instance of a class with the following methods:
573 .IP \fBline()\fR 4
574 .IX Item "line()"
575 Returns the approximate line number in which the link was encountered
576 .IP \fBtype()\fR 4
577 .IX Item "type()"
578 Returns the type of the link; one of:
579 \&\f(CW"url"\fR for things like
580 \&\f(CW\*(C`http://www.foo\*(C'\fR, \f(CW"man"\fR for man pages, or \f(CW"pod"\fR.
581 .IP \fBpage()\fR 4
582 .IX Item "page()"
583 Returns the linked\-to page or url.
584 .IP \fBnode()\fR 4
585 .IX Item "node()"
586 Returns the anchor or node within the linked\-to page, or an empty string
587 (\f(CW""\fR) if none appears in the link.
588 .SH AUTHOR
589 .IX Header "AUTHOR"
590 Please report bugs using <http://rt.cpan.org>.
591 .PP
592 Brad Appleton <[email protected]> (initial version),
593 Marek Rouchal <[email protected]>,
594 Marc Green <[email protected]> (port to Pod::Simple)
595 Ricardo Signes <[email protected]> (more porting to Pod::Simple)
596 Karl Williamson <[email protected]> (more porting to Pod::Simple)
597 .PP
598 Based on code for \fBPod::Text::pod2text()\fR written by
599 Tom Christiansen <[email protected]>