pod::checker.3

视频监控网络部分的协议ddns,的模块的实现代码,请大家大胆指正.

\&\f(CW\*(C`B<>\*(C'\fR, \f(CW\*(C`C<>\*(C'\fR, \f(CW\*(C`E<>\*(C'\fR, \f(CW\*(C`F<>\*(C'\fR, 
\&\f(CW\*(C`I<>\*(C'\fR, \f(CW\*(C`L<>\*(C'\fR, \f(CW\*(C`S<>\*(C'\fR, \f(CW\*(C`X<>\*(C'\fR, 
\&\f(CW\*(C`Z<>\*(C'\fR
.IP "\(bu" 4
nested commands \fI\s-1CMD\s0\fR<...\fI\s-1CMD\s0\fR<...>...>
.Sp
Two nested identical markup commands have been found. Generally this
does not make sense.
.IP "\(bu" 4
garbled entity \fI\s-1STRING\s0\fR
.Sp
The \fI\s-1STRING\s0\fR found cannot be interpreted as a character entity.
.IP "\(bu" 4
Entity number out of range
.Sp
An entity specified by number (dec, hex, oct) is out of range (1\-255).
.IP "\(bu" 4
malformed link L<>
.Sp
The link found cannot be parsed because it does not conform to the
syntax described in perlpod.
.IP "\(bu" 4
nonempty Z<>
.Sp
The \f(CW\*(C`Z<>\*(C'\fR sequence is supposed to be empty.
.IP "\(bu" 4
empty X<>
.Sp
The index entry specified contains nothing but whitespace.
.IP "\(bu" 4
Spurious text after =pod / =cut
.Sp
The commands \f(CW\*(C`=pod\*(C'\fR and \f(CW\*(C`=cut\*(C'\fR do not take any arguments.
.IP "\(bu" 4
Spurious character(s) after =back
.Sp
The \f(CW\*(C`=back\*(C'\fR command does not take any arguments.
.Sh "Warnings"
.IX Subsection "Warnings"
These may not necessarily cause trouble, but indicate mediocre style.
.IP "\(bu" 4
multiple occurrence of link target \fIname\fR
.Sp
The \s-1POD\s0 file has some \f(CW\*(C`=item\*(C'\fR and/or \f(CW\*(C`=head\*(C'\fR commands that have
the same text. Potential hyperlinks to such a text cannot be unique then.
This warning is printed only with warning level greater than one.
.IP "\(bu" 4
line containing nothing but whitespace in paragraph
.Sp
There is some whitespace on a seemingly empty line. \s-1POD\s0 is very sensitive
to such things, so this is flagged. \fBvi\fR users switch on the \fBlist\fR
option to avoid this problem.
.IP "\(bu" 4
previous =item has no contents
.Sp
There is a list \f(CW\*(C`=item\*(C'\fR right above the flagged line that has no
text contents. You probably want to delete empty items.
.IP "\(bu" 4
preceding non-item paragraph(s)
.Sp
A list introduced by \f(CW\*(C`=over\*(C'\fR starts with a text or verbatim paragraph,
but continues with \f(CW\*(C`=item\*(C'\fRs. Move the non-item paragraph out of the
\&\f(CW\*(C`=over\*(C'\fR/\f(CW\*(C`=back\*(C'\fR block.
.IP "\(bu" 4
=item type mismatch (\fIone\fR vs. \fItwo\fR)
.Sp
A list started with e.g. a bullet-like \f(CW\*(C`=item\*(C'\fR and continued with a
numbered one. This is obviously inconsistent. For most translators the
type of the \fIfirst\fR \f(CW\*(C`=item\*(C'\fR determines the type of the list.
.IP "\(bu" 4
\&\fIN\fR unescaped \f(CW\*(C`<>\*(C'\fR in paragraph
.Sp
Angle brackets not written as \f(CW\*(C`<lt>\*(C'\fR and \f(CW\*(C`<gt>\*(C'\fR
can potentially cause errors as they could be misinterpreted as
markup commands. This is only printed when the \-warnings level is
greater than 1.
.IP "\(bu" 4
Unknown entity
.Sp
A character entity was found that does not belong to the standard
\&\s-1ISO\s0 set or the \s-1POD\s0 specials \f(CW\*(C`verbar\*(C'\fR and \f(CW\*(C`sol\*(C'\fR.
.IP "\(bu" 4
No items in =over
.Sp
The list opened with \f(CW\*(C`=over\*(C'\fR does not contain any items.
.IP "\(bu" 4
No argument for =item
.Sp
\&\f(CW\*(C`=item\*(C'\fR without any parameters is deprecated. It should either be followed
by \f(CW\*(C`*\*(C'\fR to indicate an unordered list, by a number (optionally followed
by a dot) to indicate an ordered (numbered) list or simple text for a
definition list.
.IP "\(bu" 4
empty section in previous paragraph
.Sp
The previous section (introduced by a \f(CW\*(C`=head\*(C'\fR command) does not contain
any text. This usually indicates that something is missing. Note: A 
\&\f(CW\*(C`=head1\*(C'\fR followed immediately by \f(CW\*(C`=head2\*(C'\fR does not trigger this warning.
.IP "\(bu" 4
Verbatim paragraph in \s-1NAME\s0 section
.Sp
The \s-1NAME\s0 section (\f(CW\*(C`=head1 NAME\*(C'\fR) should consist of a single paragraph
with the script/module name, followed by a dash `\-' and a very short
description of what the thing is good for.
.IP "\(bu" 4
=head\fIn\fR without preceding higher level
.Sp
For example if there is a \f(CW\*(C`=head2\*(C'\fR in the \s-1POD\s0 file prior to a
\&\f(CW\*(C`=head1\*(C'\fR.
.Sh "Hyperlinks"
.IX Subsection "Hyperlinks"
There are some warnings with respect to malformed hyperlinks:
.IP "\(bu" 4
ignoring leading/trailing whitespace in link
.Sp
There is whitespace at the beginning or the end of the contents of 
L<...>.
.IP "\(bu" 4
(section) in '$page' deprecated
.Sp
There is a section detected in the page name of L<...>, e.g.
\&\f(CW\*(C`L<passwd(2)>\*(C'\fR. \s-1POD\s0 hyperlinks may point to \s-1POD\s0 documents only.
Please write \f(CW\*(C`C<passwd(2)>\*(C'\fR instead. Some formatters are able
to expand this to appropriate code. For links to (builtin) functions,
please say \f(CW\*(C`L<perlfunc/mkdir>\*(C'\fR, without ().
.IP "\(bu" 4
alternative text/node '%s' contains non-escaped | or /
.Sp
The characters \f(CW\*(C`|\*(C'\fR and \f(CW\*(C`/\*(C'\fR are special in the L<...> context.
Although the hyperlink parser does its best to determine which \*(L"/\*(R" is
text and which is a delimiter in case of doubt, one ought to escape
these literal characters like this:
.Sp
.Vb 2
\&  /     E<sol>
\&  |     E<verbar>
.Ve
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
\&\fBpodchecker\fR returns the number of \s-1POD\s0 syntax errors found or \-1 if
there were no \s-1POD\s0 commands at all found in the file.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
See \*(L"\s-1SYNOPSIS\s0\*(R"
.SH "INTERFACE"
.IX Header "INTERFACE"
While checking, this module collects document properties, e.g. the nodes
for hyperlinks (\f(CW\*(C`=headX\*(C'\fR, \f(CW\*(C`=item\*(C'\fR) and index entries (\f(CW\*(C`X<>\*(C'\fR).
\&\s-1POD\s0 translators can use this feature to syntax-check and get the nodes in
a first pass before actually starting to convert. This is expensive in terms
of execution time, but allows for very robust conversions.
.PP
Since PodParser\-1.24 the \fBPod::Checker\fR module uses only the \fBpoderror\fR
method to print errors and warnings. The summary output (e.g. 
\&\*(L"Pod syntax \s-1OK\s0\*(R") has been dropped from the module and has been included in
\&\fBpodchecker\fR (the script). This allows users of \fBPod::Checker\fR to
control completely the output behavior. Users of \fBpodchecker\fR (the script)
get the well-known behavior.
.ie n .IP """Pod::Checker\->new( %options )""" 4
.el .IP "\f(CWPod::Checker\->new( %options )\fR" 4
.IX Item "Pod::Checker->new( %options )"
Return a reference to a new Pod::Checker object that inherits from
Pod::Parser and is used for calling the required methods later. The
following options are recognized:
.Sp
\&\f(CW\*(C`\-warnings => num\*(C'\fR
  Print warnings if \f(CW\*(C`num\*(C'\fR is true. The higher the value of \f(CW\*(C`num\*(C'\fR,
the more warnings are printed. Currently there are only levels 1 and 2.
.Sp
\&\f(CW\*(C`\-quiet => num\*(C'\fR
  If \f(CW\*(C`num\*(C'\fR is true, do not print any errors/warnings. This is useful
when Pod::Checker is used to munge \s-1POD\s0 code into plain text from within
\&\s-1POD\s0 formatters.
.ie n .IP """$checker\->poderror( @args )""" 4
.el .IP "\f(CW$checker\->poderror( @args )\fR" 4
.IX Item "$checker->poderror( @args )"
.PD 0
.ie n .IP """$checker\->poderror( {%opts}, @args )""" 4
.el .IP "\f(CW$checker\->poderror( {%opts}, @args )\fR" 4
.IX Item "$checker->poderror( {%opts}, @args )"
.PD
Internal method for printing errors and warnings. If no options are
given, simply prints \*(L"@_\*(R". The following options are recognized and used
to form the output:
.Sp
.Vb 1
\&  \-msg
.Ve
.Sp
A message to print prior to \f(CW@args\fR.
.Sp
.Vb 1
\&  \-line
.Ve
.Sp
The line number the error occurred in.
.Sp
.Vb 1
\&  \-file
.Ve
.Sp
The file (name) the error occurred in.
.Sp
.Vb 1
\&  \-severity
.Ve
.Sp
The error level, should be '\s-1WARNING\s0' or '\s-1ERROR\s0'.
.ie n .IP """$checker\->num_errors()""" 4
.el .IP "\f(CW$checker\->num_errors()\fR" 4
.IX Item "$checker->num_errors()"
Set (if argument specified) and retrieve the number of errors found.
.ie n .IP """$checker\->num_warnings()""" 4
.el .IP "\f(CW$checker\->num_warnings()\fR" 4
.IX Item "$checker->num_warnings()"
Set (if argument specified) and retrieve the number of warnings found.
.ie n .IP """$checker\->name()""" 4
.el .IP "\f(CW$checker\->name()\fR" 4
.IX Item "$checker->name()"
Set (if argument specified) and retrieve the canonical name of \s-1POD\s0 as
found in the \f(CW\*(C`=head1 NAME\*(C'\fR section.
.ie n .IP """$checker\->node()""" 4
.el .IP "\f(CW$checker\->node()\fR" 4
.IX Item "$checker->node()"
Add (if argument specified) and retrieve the nodes (as defined by \f(CW\*(C`=headX\*(C'\fR
and \f(CW\*(C`=item\*(C'\fR) of the current \s-1POD\s0. The nodes are returned in the order of
their occurrence. They consist of plain text, each piece of whitespace is
collapsed to a single blank.
.ie n .IP """$checker\->idx()""" 4
.el .IP "\f(CW$checker\->idx()\fR" 4
.IX Item "$checker->idx()"
Add (if argument specified) and retrieve the index entries (as defined by
\&\f(CW\*(C`X<>\*(C'\fR) of the current \s-1POD\s0. They consist of plain text, each piece
of whitespace is collapsed to a single blank.
.ie n .IP """$checker\->hyperlink()""" 4
.el .IP "\f(CW$checker\->hyperlink()\fR" 4
.IX Item "$checker->hyperlink()"
Add (if argument specified) and retrieve the hyperlinks (as defined by
\&\f(CW\*(C`L<>\*(C'\fR) of the current \s-1POD\s0. They consist of a 2\-item array: line
number and \f(CW\*(C`Pod::Hyperlink\*(C'\fR object.
.SH "AUTHOR"
.IX Header "AUTHOR"
Please report bugs using <http://rt.cpan.org>.
.PP
Brad Appleton <[e-mail]> (initial version),
Marek Rouchal <[e-mail]>
.PP
Based on code for \fB\f(BIPod::Text::pod2text()\fB\fR written by
Tom Christiansen <[e-mail]>