summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorMichael Stevens <mstevens@etla.org>2001-03-15 21:25:18 +0000
committerJarkko Hietaniemi <jhi@iki.fi>2001-03-16 02:56:04 +0000
commitbbc7dcd2bd43efd6773e46b614c6eb1db5af78d2 (patch)
treecf0748288cb60b19776c0b7e0af0c8892cf713f5 /lib
parentcea6626fc5e04af2c1d079dd4d3784eb2c21174b (diff)
downloadperl-bbc7dcd2bd43efd6773e46b614c6eb1db5af78d2.tar.gz
more pod patches
Message-ID: <20010315212518.A18870@firedrake.org> p4raw-id: //depot/perl@9176
Diffstat (limited to 'lib')
-rw-r--r--lib/CPAN.pm8
-rw-r--r--lib/Class/Struct.pm4
-rw-r--r--lib/Dumpvalue.pm4
-rw-r--r--lib/ExtUtils/Embed.pm2
-rw-r--r--lib/ExtUtils/Installed.pm2
-rw-r--r--lib/ExtUtils/MM_Cygwin.pm2
-rw-r--r--lib/ExtUtils/MM_OS2.pm38
-rw-r--r--lib/ExtUtils/MM_VMS.pm4
-rw-r--r--lib/ExtUtils/MM_Win32.pm2
-rw-r--r--lib/ExtUtils/Manifest.pm2
-rw-r--r--lib/ExtUtils/Mksymlists.pm2
-rw-r--r--lib/ExtUtils/Packlist.pm2
-rw-r--r--lib/File/Basename.pm2
-rw-r--r--lib/File/Spec/VMS.pm4
-rw-r--r--lib/File/Spec/Win32.pm2
-rw-r--r--lib/FileHandle.pm2
-rw-r--r--lib/Filter/Simple.pm7
-rw-r--r--lib/Getopt/Long.pm4
-rw-r--r--lib/Locale/Constants.pm2
-rw-r--r--lib/Locale/Country.pm10
-rw-r--r--lib/Locale/Language.pm6
-rw-r--r--lib/Term/ANSIColor.pm2
-rw-r--r--lib/Test.pm2
-rw-r--r--lib/Test/Harness.pm2
-rw-r--r--lib/Text/Wrap.pm2
-rw-r--r--lib/Tie/Array.pm2
-rw-r--r--lib/Tie/Handle.pm2
-rw-r--r--lib/Tie/Hash.pm20
-rw-r--r--lib/Tie/Scalar.pm2
-rw-r--r--lib/User/pwent.pm2
-rw-r--r--lib/autouse.pm2
-rw-r--r--lib/overload.pm10
32 files changed, 86 insertions, 73 deletions
diff --git a/lib/CPAN.pm b/lib/CPAN.pm
index fdaadb3be7..7cab8c606d 100644
--- a/lib/CPAN.pm
+++ b/lib/CPAN.pm
@@ -6181,7 +6181,7 @@ beta and partially even alpha. In the following paragraphs only those
methods are documented that have proven useful over a longer time and
thus are unlikely to change.
-=over
+=over 4
=item CPAN::Author::as_glimpse()
@@ -6746,7 +6746,7 @@ that you can configure ncftp so that it works for your firewall.
Firewalls can be categorized into three basic types.
-=over
+=over 4
=item http firewall
@@ -6780,7 +6780,7 @@ FTP connections need to be done in a passive mode.
There are two that I can think off.
-=over
+=over 4
=item SOCKS
@@ -6819,7 +6819,7 @@ Your milage may vary...
=head1 FAQ
-=over
+=over 4
=item 1)
diff --git a/lib/Class/Struct.pm b/lib/Class/Struct.pm
index 185a8ff142..57b8c8611c 100644
--- a/lib/Class/Struct.pm
+++ b/lib/Class/Struct.pm
@@ -361,7 +361,7 @@ optionally preceded by a C<'*'>.
The accessor method provided by C<struct> for an element depends
on the declared type of the element.
-=over
+=over 4
=item Scalar (C<'$'> or C<'*$'>)
@@ -437,7 +437,7 @@ See Example 3 below for an example of initialization.
=head1 EXAMPLES
-=over
+=over 4
=item Example 1
diff --git a/lib/Dumpvalue.pm b/lib/Dumpvalue.pm
index c8282cfbd5..97946258a2 100644
--- a/lib/Dumpvalue.pm
+++ b/lib/Dumpvalue.pm
@@ -495,7 +495,7 @@ A new dumper is created by a call
Recognized options:
-=over
+=over 4
=item C<arrayDepth>, C<hashDepth>
@@ -563,7 +563,7 @@ method and set() method (which accept multiple arguments).
=head2 Methods
-=over
+=over 4
=item dumpValue
diff --git a/lib/ExtUtils/Embed.pm b/lib/ExtUtils/Embed.pm
index c4167a3026..b5a1bae5f6 100644
--- a/lib/ExtUtils/Embed.pm
+++ b/lib/ExtUtils/Embed.pm
@@ -295,7 +295,7 @@ ccdlflags(), xsi_header(), xsi_protos(), xsi_body()
=head1 FUNCTIONS
-=over
+=over 4
=item xsinit()
diff --git a/lib/ExtUtils/Installed.pm b/lib/ExtUtils/Installed.pm
index 6961c6fdd4..b7ff8155b3 100644
--- a/lib/ExtUtils/Installed.pm
+++ b/lib/ExtUtils/Installed.pm
@@ -208,7 +208,7 @@ described below.
=head1 FUNCTIONS
-=over
+=over 4
=item new()
diff --git a/lib/ExtUtils/MM_Cygwin.pm b/lib/ExtUtils/MM_Cygwin.pm
index abb491f1a2..45833ca259 100644
--- a/lib/ExtUtils/MM_Cygwin.pm
+++ b/lib/ExtUtils/MM_Cygwin.pm
@@ -103,7 +103,7 @@ ExtUtils::MM_Cygwin - methods to override UN*X behaviour in ExtUtils::MakeMaker
See ExtUtils::MM_Unix for a documentation of the methods provided there.
-=over
+=over 4
=item canonpath
diff --git a/lib/ExtUtils/MM_OS2.pm b/lib/ExtUtils/MM_OS2.pm
index d6bbc1c76d..a4bcf73c37 100644
--- a/lib/ExtUtils/MM_OS2.pm
+++ b/lib/ExtUtils/MM_OS2.pm
@@ -14,6 +14,28 @@ ExtUtils::MakeMaker->import(qw( $Verbose &neatvalue));
unshift @MM::ISA, 'ExtUtils::MM_OS2';
+=pod
+
+=head1 NAME
+
+ExtUtils::MM_OS2 - methods to override UN*X behaviour in ExtUtils::MakeMaker
+
+=head1 SYNOPSIS
+
+ use ExtUtils::MM_OS2; # Done internally by ExtUtils::MakeMaker if needed
+
+=head1 DESCRIPTION
+
+See ExtUtils::MM_Unix for a documentation of the methods provided
+there. This package overrides the implementation of these methods, not
+the semantics.
+
+=head1 METHODS
+
+=over 4
+
+=cut
+
sub dlsyms {
my($self,%attribs) = @_;
@@ -120,19 +142,11 @@ sub export_list
}
1;
-__END__
-
-=head1 NAME
-
-ExtUtils::MM_OS2 - methods to override UN*X behaviour in ExtUtils::MakeMaker
-=head1 SYNOPSIS
-
- use ExtUtils::MM_OS2; # Done internally by ExtUtils::MakeMaker if needed
+__END__
-=head1 DESCRIPTION
+=pod
-See ExtUtils::MM_Unix for a documentation of the methods provided
-there. This package overrides the implementation of these methods, not
-the semantics.
+=back
+=cut
diff --git a/lib/ExtUtils/MM_VMS.pm b/lib/ExtUtils/MM_VMS.pm
index b753e2a819..ef5b541057 100644
--- a/lib/ExtUtils/MM_VMS.pm
+++ b/lib/ExtUtils/MM_VMS.pm
@@ -41,7 +41,7 @@ the semantics.
=head2 Methods always loaded
-=over
+=over 4
=item wraplist
@@ -173,7 +173,7 @@ For overridden methods, documentation is limited to an explanation
of why this method overrides the MM_Unix method; see the ExtUtils::MM_Unix
documentation for more details.
-=over
+=over 4
=item guess_name (override)
diff --git a/lib/ExtUtils/MM_Win32.pm b/lib/ExtUtils/MM_Win32.pm
index 80e247d27c..709be20ecc 100644
--- a/lib/ExtUtils/MM_Win32.pm
+++ b/lib/ExtUtils/MM_Win32.pm
@@ -16,7 +16,7 @@ See ExtUtils::MM_Unix for a documentation of the methods provided
there. This package overrides the implementation of these methods, not
the semantics.
-=over
+=over 4
=cut
diff --git a/lib/ExtUtils/Manifest.pm b/lib/ExtUtils/Manifest.pm
index 3ac0fbf862..244214a765 100644
--- a/lib/ExtUtils/Manifest.pm
+++ b/lib/ExtUtils/Manifest.pm
@@ -447,7 +447,7 @@ produced.
All diagnostic output is sent to C<STDERR>.
-=over
+=over 4
=item C<Not in MANIFEST:> I<file>
diff --git a/lib/ExtUtils/Mksymlists.pm b/lib/ExtUtils/Mksymlists.pm
index c06b393be3..5f5ea063c6 100644
--- a/lib/ExtUtils/Mksymlists.pm
+++ b/lib/ExtUtils/Mksymlists.pm
@@ -217,7 +217,7 @@ C<Mksymlists>, which is exported by default from C<ExtUtils::Mksymlists>.
It takes one argument, a list of key-value pairs, in which the following
keys are recognized:
-=over
+=over 4
=item DLBASE
diff --git a/lib/ExtUtils/Packlist.pm b/lib/ExtUtils/Packlist.pm
index 88ea206196..309d72764d 100644
--- a/lib/ExtUtils/Packlist.pm
+++ b/lib/ExtUtils/Packlist.pm
@@ -200,7 +200,7 @@ filename followed by the key=value pairs from the hash. Reading back the
=head1 FUNCTIONS
-=over
+=over 4
=item new()
diff --git a/lib/File/Basename.pm b/lib/File/Basename.pm
index 94aac2dd44..297386f57b 100644
--- a/lib/File/Basename.pm
+++ b/lib/File/Basename.pm
@@ -95,7 +95,7 @@ would yield
$dir eq 'Doc_Root:[Help]'
$type eq '.Rnh'
-=over
+=over 4
=item C<basename>
diff --git a/lib/File/Spec/VMS.pm b/lib/File/Spec/VMS.pm
index 60b0ec8e50..57c4005d99 100644
--- a/lib/File/Spec/VMS.pm
+++ b/lib/File/Spec/VMS.pm
@@ -26,7 +26,7 @@ See File::Spec::Unix for a documentation of the methods provided
there. This package overrides the implementation of these methods, not
the semantics.
-=over
+=over 4
=item eliminate_macros
@@ -138,7 +138,7 @@ sub fixpath {
=head2 Methods always loaded
-=over
+=over 4
=item canonpath (override)
diff --git a/lib/File/Spec/Win32.pm b/lib/File/Spec/Win32.pm
index f5d6cda2bc..860ae0c2b2 100644
--- a/lib/File/Spec/Win32.pm
+++ b/lib/File/Spec/Win32.pm
@@ -23,7 +23,7 @@ See File::Spec::Unix for a documentation of the methods provided
there. This package overrides the implementation of these methods, not
the semantics.
-=over
+=over 4
=item devnull
diff --git a/lib/FileHandle.pm b/lib/FileHandle.pm
index 5eb3a89adc..cd80d19024 100644
--- a/lib/FileHandle.pm
+++ b/lib/FileHandle.pm
@@ -225,7 +225,7 @@ supported C<FileHandle> methods:
Furthermore, for doing normal I/O you might need these:
-=over
+=over 4
=item $fh->print
diff --git a/lib/Filter/Simple.pm b/lib/Filter/Simple.pm
index d5aa55afdf..fc41362bd5 100644
--- a/lib/Filter/Simple.pm
+++ b/lib/Filter/Simple.pm
@@ -52,7 +52,6 @@ __END__
Filter::Simple - Simplified source filtering
-
=head1 SYNOPSIS
# in MyFilter.pm:
@@ -141,7 +140,7 @@ to the sequence C<die 'BANG' if $BANG> in any piece of code following a
C<use BANG;> statement (until the next C<no BANG;> statement, if any):
package BANG;
-
+
use Filter::Util::Call ;
sub import {
@@ -198,7 +197,7 @@ contents of $_ to change the source code in the desired manner.
In other words, the previous example, would become:
package BANG;
-
+
use Filter::Simple sub {
s/BANG\s+BANG/die 'BANG' if \$BANG/g;
};
@@ -218,7 +217,7 @@ list to the filtering subroutine, so the BANG.pm filter could easily
be made parametric:
package BANG;
-
+
use Filter::Simple sub {
my ($die_msg, $var_name) = @_;
s/BANG\s+BANG/die '$die_msg' if \${$var_name}/g;
diff --git a/lib/Getopt/Long.pm b/lib/Getopt/Long.pm
index 472527d4a7..ff0475b34b 100644
--- a/lib/Getopt/Long.pm
+++ b/lib/Getopt/Long.pm
@@ -1326,7 +1326,7 @@ used on the command line.
The argument specification can be
-=over
+=over 4
=item !
@@ -1352,7 +1352,7 @@ The C<+> specifier is ignored if the option destination is not a scalar.
The option requires an argument of the given type. Supported types
are:
-=over
+=over 4
=item s
diff --git a/lib/Locale/Constants.pm b/lib/Locale/Constants.pm
index cc11969c2c..957207ed90 100644
--- a/lib/Locale/Constants.pm
+++ b/lib/Locale/Constants.pm
@@ -31,7 +31,7 @@ Locale::Constants - constants for Locale codes
=head1 SYNOPSIS
use Locale::Constants;
-
+
$codeset = LOCALE_CODE_ALPHA_2;
=head1 DESCRIPTION
diff --git a/lib/Locale/Country.pm b/lib/Locale/Country.pm
index f60b1352b2..ea446ee5d9 100644
--- a/lib/Locale/Country.pm
+++ b/lib/Locale/Country.pm
@@ -7,13 +7,13 @@ Locale::Country - ISO codes for country identification (ISO 3166)
=head1 SYNOPSIS
use Locale::Country;
-
+
$country = code2country('jp'); # $country gets 'Japan'
$code = country2code('Norway'); # $code gets 'no'
-
+
@codes = all_country_codes();
@names = all_country_names();
-
+
# add "uk" as a pseudo country code for United Kingdom
Locale::Country::_alias_code('uk' => 'gb');
@@ -285,7 +285,7 @@ an ISO standard. If you would like 'uk' to work as the two-letter
code for United Kingdom, use the following:
use Locale::Country;
-
+
Locale::Country::_alias_code('uk' => 'gb');
With this code, both "uk" and "gb" are valid codes for United Kingdom,
@@ -325,7 +325,7 @@ The user is prompted for a country code, and then told the corresponding
country name:
$| = 1; # turn off buffering
-
+
print "Enter country code: ";
chop($code = <STDIN>);
$country = code2country($code, LOCALE_CODE_ALPHA_2);
diff --git a/lib/Locale/Language.pm b/lib/Locale/Language.pm
index 391cffab78..c561157deb 100644
--- a/lib/Locale/Language.pm
+++ b/lib/Locale/Language.pm
@@ -7,10 +7,10 @@ Locale::Language - ISO two letter codes for language identification (ISO 639)
=head1 SYNOPSIS
use Locale::Language;
-
+
$lang = code2language('en'); # $lang gets 'English'
$code = language2code('French'); # $code gets 'fr'
-
+
@codes = all_language_codes();
@names = all_language_names();
@@ -173,7 +173,7 @@ The user is prompted for a language code, and then told the corresponding
language name:
$| = 1; # turn off buffering
-
+
print "Enter language code: ";
chop($code = <STDIN>);
$lang = code2language($code);
diff --git a/lib/Term/ANSIColor.pm b/lib/Term/ANSIColor.pm
index b61efcb045..09ca297d33 100644
--- a/lib/Term/ANSIColor.pm
+++ b/lib/Term/ANSIColor.pm
@@ -187,7 +187,7 @@ Term::ANSIColor - Color screen output using ANSI escape sequences
This module has two interfaces, one through color() and colored() and the
other through constants.
-
+
color() takes any number of strings as arguments and considers them to be
space-separated lists of attributes. It then forms and returns the escape
sequence to set those attributes. It doesn't print it out, just returns
diff --git a/lib/Test.pm b/lib/Test.pm
index 89b9cec43f..19a9089978 100644
--- a/lib/Test.pm
+++ b/lib/Test.pm
@@ -151,7 +151,7 @@ __END__
=head1 NAME
- Test - provides a simple framework for writing test scripts
+Test - provides a simple framework for writing test scripts
=head1 SYNOPSIS
diff --git a/lib/Test/Harness.pm b/lib/Test/Harness.pm
index 55a84fe066..73f3f79119 100644
--- a/lib/Test/Harness.pm
+++ b/lib/Test/Harness.pm
@@ -650,7 +650,7 @@ test program.
=over 4
-=item B<1..M>
+=item B<'1..M'>
This header tells how many tests there will be. It should be the
first line output by your test program (but its okay if its preceded
diff --git a/lib/Text/Wrap.pm b/lib/Text/Wrap.pm
index 579e09b395..3c88508b36 100644
--- a/lib/Text/Wrap.pm
+++ b/lib/Text/Wrap.pm
@@ -120,7 +120,7 @@ B<Example 2>
$huge = 'overflow';
B<Example 3>
-
+
use Text::Wrap
$Text::Wrap::columns = 72;
diff --git a/lib/Tie/Array.pm b/lib/Tie/Array.pm
index f4c6193596..5b8423e943 100644
--- a/lib/Tie/Array.pm
+++ b/lib/Tie/Array.pm
@@ -179,7 +179,7 @@ For developers wishing to write their own tied arrays, the required methods
are briefly defined below. See the L<perltie> section for more detailed
descriptive, as well as example code:
-=over
+=over 4
=item TIEARRAY classname, LIST
diff --git a/lib/Tie/Handle.pm b/lib/Tie/Handle.pm
index 81b0792249..638cdf7861 100644
--- a/lib/Tie/Handle.pm
+++ b/lib/Tie/Handle.pm
@@ -33,7 +33,7 @@ For developers wishing to write their own tied-handle classes, the methods
are summarized below. The L<perltie> section not only documents these, but
has sample code as well:
-=over
+=over 4
=item TIEHANDLE classname, LIST
diff --git a/lib/Tie/Hash.pm b/lib/Tie/Hash.pm
index 7399d8b853..3231155c81 100644
--- a/lib/Tie/Hash.pm
+++ b/lib/Tie/Hash.pm
@@ -10,24 +10,24 @@ Tie::Hash, Tie::StdHash - base class definitions for tied hashes
package NewHash;
require Tie::Hash;
-
+
@ISA = (Tie::Hash);
-
+
sub DELETE { ... } # Provides needed method
sub CLEAR { ... } # Overrides inherited method
-
-
+
+
package NewStdHash;
require Tie::Hash;
-
+
@ISA = (Tie::StdHash);
-
+
# All methods provided by default, define only those needing overrides
sub DELETE { ... }
-
-
+
+
package main;
-
+
tie %new_hash, 'NewHash';
tie %new_std_hash, 'NewStdHash';
@@ -46,7 +46,7 @@ For developers wishing to write their own tied hashes, the required methods
are briefly defined below. See the L<perltie> section for more detailed
descriptive, as well as example code:
-=over
+=over 4
=item TIEHASH classname, LIST
diff --git a/lib/Tie/Scalar.pm b/lib/Tie/Scalar.pm
index 39480c8a28..bcaad0b11e 100644
--- a/lib/Tie/Scalar.pm
+++ b/lib/Tie/Scalar.pm
@@ -47,7 +47,7 @@ For developers wishing to write their own tied-scalar classes, the methods
are summarized below. The L<perltie> section not only documents these, but
has sample code as well:
-=over
+=over 4
=item TIESCALAR classname, LIST
diff --git a/lib/User/pwent.pm b/lib/User/pwent.pm
index edd5f51dc7..91d23bd3f6 100644
--- a/lib/User/pwent.pm
+++ b/lib/User/pwent.pm
@@ -287,7 +287,7 @@ Tom Christiansen
=head1 HISTORY
-=over
+=over 4
=item March 18th, 2000
diff --git a/lib/autouse.pm b/lib/autouse.pm
index 179c382ca2..5e4f30f649 100644
--- a/lib/autouse.pm
+++ b/lib/autouse.pm
@@ -116,7 +116,7 @@ with the correct definitions.
Using C<autouse> will move important steps of your program's execution
from compile time to runtime. This can
-=over
+=over 4
=item *
diff --git a/lib/overload.pm b/lib/overload.pm
index 21a4b671ff..d355f6aa85 100644
--- a/lib/overload.pm
+++ b/lib/overload.pm
@@ -267,7 +267,7 @@ is called with arguments C<($a,undef,'')> when $a++ is executed.
Two types of mutators have different calling conventions:
-=over
+=over 4
=item C<++> and C<-->
@@ -450,7 +450,7 @@ A computer-readable form of the above table is available in the hash
Inheritance interacts with overloading in two ways.
-=over
+=over 4
=item Strings as values of C<use overload> directive
@@ -1028,7 +1028,7 @@ reference to the intermediate array, which keeps a reference to an
actual array, and the access hash. The tie()ing object for the access
hash is a reference to a reference to the actual array, so
-=over
+=over 4
=item *
@@ -1058,8 +1058,8 @@ Put this in F<symbolic.pm> in your Perl library directory:
}
This module is very unusual as overloaded modules go: it does not
-provide any usual overloaded operators, instead it provides the L<Last
-Resort> operator C<nomethod>. In this example the corresponding
+provide any usual overloaded operators, instead it provides the
+L<Last Resort> operator C<nomethod>. In this example the corresponding
subroutine returns an object which encapsulates operations done over
the objects: C<new symbolic 3> contains C<['n', 3]>, C<2 + new
symbolic 3> contains C<['+', 2, ['n', 3]]>.