diff options
author | Michael Stevens <mstevens@etla.org> | 2001-03-15 21:25:18 +0000 |
---|---|---|
committer | Jarkko Hietaniemi <jhi@iki.fi> | 2001-03-16 02:56:04 +0000 |
commit | bbc7dcd2bd43efd6773e46b614c6eb1db5af78d2 (patch) | |
tree | cf0748288cb60b19776c0b7e0af0c8892cf713f5 /ext | |
parent | cea6626fc5e04af2c1d079dd4d3784eb2c21174b (diff) | |
download | perl-bbc7dcd2bd43efd6773e46b614c6eb1db5af78d2.tar.gz |
more pod patches
Message-ID: <20010315212518.A18870@firedrake.org>
p4raw-id: //depot/perl@9176
Diffstat (limited to 'ext')
-rw-r--r-- | ext/B/B/Bytecode.pm | 4 | ||||
-rw-r--r-- | ext/DB_File/DB_File.pm | 64 | ||||
-rw-r--r-- | ext/Data/Dumper/Dumper.pm | 1 | ||||
-rw-r--r-- | ext/Devel/Peek/Peek.pm | 2 | ||||
-rw-r--r-- | ext/Filter/Util/Call/Call.pm | 58 | ||||
-rw-r--r-- | ext/IO/lib/IO/Handle.pm | 4 | ||||
-rw-r--r-- | ext/IO/lib/IO/Seekable.pm | 4 | ||||
-rw-r--r-- | ext/IO/lib/IO/Socket/UNIX.pm | 2 | ||||
-rw-r--r-- | ext/IPC/SysV/Msg.pm | 2 | ||||
-rw-r--r-- | ext/IPC/SysV/Semaphore.pm | 2 | ||||
-rw-r--r-- | ext/IPC/SysV/SysV.pm | 2 | ||||
-rw-r--r-- | ext/NDBM_File/NDBM_File.pm | 6 | ||||
-rw-r--r-- | ext/ODBM_File/ODBM_File.pm | 6 | ||||
-rw-r--r-- | ext/Socket/Socket.pm | 2 | ||||
-rw-r--r-- | ext/Storable/Storable.pm | 6 | ||||
-rw-r--r-- | ext/Sys/Syslog/Syslog.pm | 2 | ||||
-rw-r--r-- | ext/Thread/Thread.pm | 2 | ||||
-rw-r--r-- | ext/Thread/Thread/Queue.pm | 2 | ||||
-rw-r--r-- | ext/attrs/attrs.pm | 2 |
19 files changed, 88 insertions, 85 deletions
diff --git a/ext/B/B/Bytecode.pm b/ext/B/B/Bytecode.pm index 54d7c533c8..1954116298 100644 --- a/ext/B/B/Bytecode.pm +++ b/ext/B/B/Bytecode.pm @@ -967,9 +967,9 @@ Output (bytecode) assembler source rather than piping it through the assembler and outputting bytecode. =item B<-upackage> - + Stores package in the output. - + =back =head1 EXAMPLES diff --git a/ext/DB_File/DB_File.pm b/ext/DB_File/DB_File.pm index c8302168f8..344227fcc0 100644 --- a/ext/DB_File/DB_File.pm +++ b/ext/DB_File/DB_File.pm @@ -388,8 +388,8 @@ DB_File - Perl5 access to Berkeley DB version 1.x =head1 SYNOPSIS - use DB_File ; - + use DB_File; + [$X =] tie %hash, 'DB_File', [$filename, $flags, $mode, $DB_HASH] ; [$X =] tie %hash, 'DB_File', $filename, $flags, $mode, $DB_BTREE ; [$X =] tie @array, 'DB_File', $filename, $flags, $mode, $DB_RECNO ; @@ -699,7 +699,7 @@ contents of the database. here is the output: Banana Exists - + orange -> orange tomato -> red banana -> yellow @@ -797,13 +797,13 @@ code: $filename = "tree" ; unlink $filename ; - + # Enable duplicate records $DB_BTREE->{'flags'} = R_DUP ; - + tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; - + # Add some key/value pairs to the file $h{'Wall'} = 'Larry' ; $h{'Wall'} = 'Brick' ; # Note the duplicate key @@ -847,25 +847,25 @@ Here is the script above rewritten using the C<seq> API method. use warnings ; use strict ; use DB_File ; - + use vars qw($filename $x %h $status $key $value) ; $filename = "tree" ; unlink $filename ; - + # Enable duplicate records $DB_BTREE->{'flags'} = R_DUP ; - + $x = tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; - + # Add some key/value pairs to the file $h{'Wall'} = 'Larry' ; $h{'Wall'} = 'Brick' ; # Note the duplicate key $h{'Wall'} = 'Brick' ; # Note the duplicate key and value $h{'Smith'} = 'John' ; $h{'mouse'} = 'mickey' ; - + # iterate through the btree using seq # and print each key/value pair. $key = $value = 0 ; @@ -873,7 +873,7 @@ Here is the script above rewritten using the C<seq> API method. $status == 0 ; $status = $x->seq($key, $value, R_NEXT) ) { print "$key -> $value\n" } - + undef $x ; untie %h ; @@ -919,14 +919,14 @@ this: use warnings ; use strict ; use DB_File ; - + use vars qw($filename $x %h ) ; $filename = "tree" ; - + # Enable duplicate records $DB_BTREE->{'flags'} = R_DUP ; - + $x = tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; @@ -942,7 +942,7 @@ this: @list = $x->get_dup("Smith") ; print "Smith => [@list]\n" ; - + @list = $x->get_dup("Dog") ; print "Dog => [@list]\n" ; @@ -969,23 +969,23 @@ Assuming the database from the previous example: use warnings ; use strict ; use DB_File ; - + use vars qw($filename $x %h $found) ; my $filename = "tree" ; - + # Enable duplicate records $DB_BTREE->{'flags'} = R_DUP ; - + $x = tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; $found = ( $x->find_dup("Wall", "Larry") == 0 ? "" : "not") ; print "Larry Wall is $found there\n" ; - + $found = ( $x->find_dup("Wall", "Harry") == 0 ? "" : "not") ; print "Harry Wall is $found there\n" ; - + undef $x ; untie %h ; @@ -1008,14 +1008,14 @@ Again assuming the existence of the C<tree> database use warnings ; use strict ; use DB_File ; - + use vars qw($filename $x %h $found) ; my $filename = "tree" ; - + # Enable duplicate records $DB_BTREE->{'flags'} = R_DUP ; - + $x = tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; @@ -1023,7 +1023,7 @@ Again assuming the existence of the C<tree> database $found = ( $x->find_dup("Wall", "Larry") == 0 ? "" : "not") ; print "Larry Wall is $found there\n" ; - + undef $x ; untie %h ; @@ -1071,22 +1071,22 @@ and print the first matching key/value pair given a partial key. $x = tie %h, "DB_File", $filename, O_RDWR|O_CREAT, 0640, $DB_BTREE or die "Cannot open $filename: $!\n"; - + # Add some key/value pairs to the file $h{'mouse'} = 'mickey' ; $h{'Wall'} = 'Larry' ; $h{'Walls'} = 'Brick' ; $h{'Smith'} = 'John' ; - + $key = $value = 0 ; print "IN ORDER\n" ; for ($st = $x->seq($key, $value, R_FIRST) ; $st == 0 ; $st = $x->seq($key, $value, R_NEXT) ) - + { print "$key -> $value\n" } - + print "\nPARTIAL MATCH\n" ; match "Wa" ; @@ -1250,14 +1250,14 @@ L<THE API INTERFACE>). use vars qw(@h $H $file $i) ; use DB_File ; use Fcntl ; - + $file = "text" ; unlink $file ; $H = tie @h, "DB_File", $file, O_RDWR|O_CREAT, 0640, $DB_RECNO or die "Cannot open file $file: $!\n" ; - + # first create a text file to play with $h[0] = "zero" ; $h[1] = "one" ; @@ -1265,7 +1265,7 @@ L<THE API INTERFACE>). $h[3] = "three" ; $h[4] = "four" ; - + # Print the records in order. # # The length method is needed here because evaluating a tied diff --git a/ext/Data/Dumper/Dumper.pm b/ext/Data/Dumper/Dumper.pm index a8e59ab379..b092a2202b 100644 --- a/ext/Data/Dumper/Dumper.pm +++ b/ext/Data/Dumper/Dumper.pm @@ -592,7 +592,6 @@ __END__ Data::Dumper - stringified perl data structures, suitable for both printing and C<eval> - =head1 SYNOPSIS use Data::Dumper; diff --git a/ext/Devel/Peek/Peek.pm b/ext/Devel/Peek/Peek.pm index 08501728c0..112412a942 100644 --- a/ext/Devel/Peek/Peek.pm +++ b/ext/Devel/Peek/Peek.pm @@ -432,7 +432,7 @@ Looks like this: This shows that -=over +=over 4 =item * diff --git a/ext/Filter/Util/Call/Call.pm b/ext/Filter/Util/Call/Call.pm index 1936bbeaac..a21f671c97 100644 --- a/ext/Filter/Util/Call/Call.pm +++ b/ext/Filter/Util/Call/Call.pm @@ -58,7 +58,7 @@ __END__ Filter::Util::Call - Perl Source Filter Utility Module =head1 SYNOPSIS - + use Filter::Util::Call ; =head1 DESCRIPTION @@ -74,7 +74,7 @@ filter> and the second as I<closure filter>. Here is a skeleton for the I<method filter>: package MyFilter ; - + use Filter::Util::Call ; sub import @@ -82,28 +82,28 @@ Here is a skeleton for the I<method filter>: my($type, @arguments) = @_ ; filter_add([]) ; } - + sub filter { my($self) = @_ ; my($status) ; - + $status = filter_read() ; $status ; } - + 1 ; and this is the equivalent skeleton for the I<closure filter>: package MyFilter ; - + use Filter::Util::Call ; sub import { my($type, @arguments) = @_ ; - + filter_add( sub { @@ -112,7 +112,7 @@ and this is the equivalent skeleton for the I<closure filter>: $status ; } ) } - + 1 ; To make use of either of the two filter modules above, place the line @@ -293,26 +293,26 @@ occurrences of the string C<"Joe"> to C<"Jim">. Not particularly Useful, but it is the first example and I wanted to keep it simple. package Joe2Jim ; - + use Filter::Util::Call ; sub import { my($type) = @_ ; - + filter_add(bless []) ; } - + sub filter { my($self) = @_ ; my($status) ; - + s/Joe/Jim/g if ($status = filter_read()) > 0 ; $status ; } - + 1 ; Here is an example of using the filter: @@ -333,10 +333,10 @@ I<closure filter>. To reflect its enhanced role, the filter is called C<Subst>. package Subst ; - + use Filter::Util::Call ; use Carp ; - + sub import { croak("usage: use Subst qw(from to)") @@ -371,14 +371,14 @@ will print a count of the number of substitutions actually made. Note that C<$status> is set to C<1> in this case. package Count ; - + use Filter::Util::Call ; - + sub filter { my ($self) = @_ ; my ($status) ; - + if (($status = filter_read()) > 0 ) { s/Joe/Jim/g ; ++ $$self ; @@ -391,14 +391,14 @@ Note that C<$status> is set to C<1> in this case. $status ; } - + sub import { my ($self) = @_ ; my ($count) = 0 ; filter_add(\$count) ; } - + 1 ; Here is a script which uses it: @@ -429,38 +429,38 @@ When used as a filter we want to invoke it like this: Here is the module. package NewSubst ; - + use Filter::Util::Call ; use Carp ; - + sub import { my ($self, $start, $stop, $from, $to) = @_ ; my ($found) = 0 ; croak("usage: use Subst qw(start stop from to)") unless @_ == 5 ; - + filter_add( sub { my ($status) ; - + if (($status = filter_read()) > 0) { - + $found = 1 if $found == 0 and /$start/ ; - + if ($found) { s/$from/$to/ ; filter_del() if /$stop/ ; } - + } $status ; } ) - + } - + 1 ; =head1 AUTHOR diff --git a/ext/IO/lib/IO/Handle.pm b/ext/IO/lib/IO/Handle.pm index fb754a60bf..063341aeb4 100644 --- a/ext/IO/lib/IO/Handle.pm +++ b/ext/IO/lib/IO/Handle.pm @@ -100,7 +100,7 @@ The following methods are not supported on a per-filehandle basis. Furthermore, for doing normal I/O you might need these: -=over +=over 4 =item $io->fdopen ( FD, MODE ) @@ -206,7 +206,7 @@ failure. Lastly, there is a special method for working under B<-T> and setuid/gid scripts: -=over +=over 4 =item $io->untaint diff --git a/ext/IO/lib/IO/Seekable.pm b/ext/IO/lib/IO/Seekable.pm index 243a971acc..d3dfa1e697 100644 --- a/ext/IO/lib/IO/Seekable.pm +++ b/ext/IO/lib/IO/Seekable.pm @@ -34,7 +34,7 @@ Uses the value of a previous getpos call to return to a previously visited position. Returns "0 but true" on success, C<undef> on failure. =back - + See L<perlfunc> for complete descriptions of each of the following supported C<IO::Seekable> methods, which are just front ends for the corresponding built-in functions: @@ -80,7 +80,7 @@ of zero is returned as the string C<"0 but true"> Returns the IO::File's current position, or -1 on error. =back - + =head1 SEE ALSO L<perlfunc>, diff --git a/ext/IO/lib/IO/Socket/UNIX.pm b/ext/IO/lib/IO/Socket/UNIX.pm index 2a11752d02..53652423f9 100644 --- a/ext/IO/lib/IO/Socket/UNIX.pm +++ b/ext/IO/lib/IO/Socket/UNIX.pm @@ -103,7 +103,7 @@ be a C<Peer> specification. NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE - + As of VERSION 1.18 all IO::Socket objects have autoflush turned on by default. This was not the case with earlier releases. diff --git a/ext/IPC/SysV/Msg.pm b/ext/IPC/SysV/Msg.pm index 120a5b2d3a..a0932389cb 100644 --- a/ext/IPC/SysV/Msg.pm +++ b/ext/IPC/SysV/Msg.pm @@ -126,6 +126,8 @@ IPC::Msg - SysV Msg IPC object class =head1 DESCRIPTION +A class providing an object based interface to SysV IPC message queues. + =head1 METHODS =over 4 diff --git a/ext/IPC/SysV/Semaphore.pm b/ext/IPC/SysV/Semaphore.pm index faf7411950..1dac5dcdae 100644 --- a/ext/IPC/SysV/Semaphore.pm +++ b/ext/IPC/SysV/Semaphore.pm @@ -172,6 +172,8 @@ IPC::Semaphore - SysV Semaphore IPC object class =head1 DESCRIPTION +A class providing an object based interface to SysV IPC semaphores. + =head1 METHODS =over 4 diff --git a/ext/IPC/SysV/SysV.pm b/ext/IPC/SysV/SysV.pm index bebb8fd81b..0cc74004da 100644 --- a/ext/IPC/SysV/SysV.pm +++ b/ext/IPC/SysV/SysV.pm @@ -74,7 +74,7 @@ C<IPC::SysV> defines and conditionally exports all the constants defined in your system include files which are needed by the SysV IPC calls. -=over +=over 4 =item ftok( PATH, ID ) diff --git a/ext/NDBM_File/NDBM_File.pm b/ext/NDBM_File/NDBM_File.pm index b2804597a1..a088bd3c33 100644 --- a/ext/NDBM_File/NDBM_File.pm +++ b/ext/NDBM_File/NDBM_File.pm @@ -28,11 +28,11 @@ NDBM_File - Tied access to ndbm files $h{newkey} = newvalue; print $h{oldkey}; ... - + untie %h; - + =head1 DESCRIPTION - + C<NDBM_File> establishes a connection between a Perl hash variable and a file in NDBM_File format;. You can manipulate the data in the file just as if it were in a Perl hash, but when your program exits, the diff --git a/ext/ODBM_File/ODBM_File.pm b/ext/ODBM_File/ODBM_File.pm index 9e8e008e02..c7b61d84ff 100644 --- a/ext/ODBM_File/ODBM_File.pm +++ b/ext/ODBM_File/ODBM_File.pm @@ -28,11 +28,11 @@ ODBM_File - Tied access to odbm files $h{newkey} = newvalue; print $h{oldkey}; ... - + untie %h; - + =head1 DESCRIPTION - + C<ODBM_File> establishes a connection between a Perl hash variable and a file in ODBM_File format;. You can manipulate the data in the file just as if it were in a Perl hash, but when your program exits, the diff --git a/ext/Socket/Socket.pm b/ext/Socket/Socket.pm index 90e16e6e19..344c87dc94 100644 --- a/ext/Socket/Socket.pm +++ b/ext/Socket/Socket.pm @@ -56,7 +56,7 @@ be imported individually, and with the C<:crlf> export tag: In addition, some structure manipulation functions are available: -=over +=over 4 =item inet_aton HOSTNAME diff --git a/ext/Storable/Storable.pm b/ext/Storable/Storable.pm index 86c513575a..fa15b010bd 100644 --- a/ext/Storable/Storable.pm +++ b/ext/Storable/Storable.pm @@ -527,7 +527,7 @@ same object. Here is the hooking interface: -=over +=over 4 =item C<STORABLE_freeze> I<obj>, I<cloning> @@ -596,7 +596,7 @@ Returned value: none. Predicates are not exportable. They must be called by explicitely prefixing them with the Storable package name. -=over +=over 4 =item C<Storable::last_op_in_netorder> @@ -623,7 +623,7 @@ serialization string? There are a few things you need to know however: -=over +=over 4 =item * diff --git a/ext/Sys/Syslog/Syslog.pm b/ext/Sys/Syslog/Syslog.pm index 71f5b828d0..9c05dcd1f5 100644 --- a/ext/Sys/Syslog/Syslog.pm +++ b/ext/Sys/Syslog/Syslog.pm @@ -46,7 +46,7 @@ just like C<syslog(3)>. Syslog provides the functions: -=over +=over 4 =item openlog $ident, $logopt, $facility diff --git a/ext/Thread/Thread.pm b/ext/Thread/Thread.pm index f8a8a26bbc..3a545482a9 100644 --- a/ext/Thread/Thread.pm +++ b/ext/Thread/Thread.pm @@ -22,7 +22,7 @@ Thread - manipulate threads in Perl (EXPERIMENTAL, subject to change) $result = $t->eval; $t->detach; $flags = $t->flags; - + if ($t->done) { $t->join; } diff --git a/ext/Thread/Thread/Queue.pm b/ext/Thread/Thread/Queue.pm index 831573c726..8ace16d48b 100644 --- a/ext/Thread/Thread/Queue.pm +++ b/ext/Thread/Thread/Queue.pm @@ -59,7 +59,7 @@ before checking to make sure that it stays in a consistent state) =head1 SEE ALSO L<Thread> - + =cut sub new { diff --git a/ext/attrs/attrs.pm b/ext/attrs/attrs.pm index 2070632558..6c50beaa5d 100644 --- a/ext/attrs/attrs.pm +++ b/ext/attrs/attrs.pm @@ -31,7 +31,7 @@ C<attrs::get> on a subroutine reference or name returns its list of attribute names. Notice that C<attrs::get> is not exported. Valid attributes are as follows. -=over +=over 4 =item method |