changed POD formatting
This commit is contained in:
parent
bf5a0145ae
commit
2b6eb201a9
55 changed files with 1188 additions and 3220 deletions
|
|
@ -61,14 +61,10 @@ These subroutines are available from this package:
|
|||
|
||||
Returns a number with commas applied at each third character.
|
||||
|
||||
=over
|
||||
|
||||
=item integer
|
||||
=head3 integer
|
||||
|
||||
Any old number will do.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub commify {
|
||||
|
|
@ -83,18 +79,14 @@ sub commify {
|
|||
|
||||
Returns a boolean value as to whether the value is in the array.
|
||||
|
||||
=over
|
||||
|
||||
=item value
|
||||
=head3 value
|
||||
|
||||
The value to check for.
|
||||
|
||||
=item list
|
||||
=head3 list
|
||||
|
||||
An array to look for the value in.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub isIn {
|
||||
|
|
@ -109,14 +101,10 @@ sub isIn {
|
|||
|
||||
Searches through an array looking for commas and replaces them with semi-colons. Also replaces carriage returns with spaces. This is useful for exporting comma separated data.
|
||||
|
||||
=over
|
||||
|
||||
=item array
|
||||
=head3 array
|
||||
|
||||
A reference to the array to look through.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub makeArrayCommaSafe {
|
||||
|
|
@ -130,14 +118,10 @@ sub makeArrayCommaSafe {
|
|||
|
||||
Searches through an array looking for tabs and replaces them with four spaces. Also replaces carriage returns with a space. This is useful for exporting tab separated data.
|
||||
|
||||
=over
|
||||
|
||||
=item array
|
||||
=head3 array
|
||||
|
||||
A reference to the array to look through.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub makeArrayTabSafe {
|
||||
|
|
@ -151,14 +135,10 @@ sub makeArrayTabSafe {
|
|||
|
||||
Replaces commas with semi-colons and carriage returns with spaces.
|
||||
|
||||
=over
|
||||
|
||||
=item text
|
||||
=head3 text
|
||||
|
||||
The text to search through.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub makeCommaSafe {
|
||||
|
|
@ -173,14 +153,10 @@ sub makeCommaSafe {
|
|||
|
||||
Replaces tabs with four spaces and carriage returns with a space each.
|
||||
|
||||
=over
|
||||
|
||||
=item text
|
||||
=head3 text
|
||||
|
||||
The text to search through.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub makeTabSafe {
|
||||
|
|
@ -196,18 +172,14 @@ sub makeTabSafe {
|
|||
|
||||
Returns an integer between the low and high number.
|
||||
|
||||
=over
|
||||
|
||||
=item low
|
||||
=head3 low
|
||||
|
||||
The lowest possible value. Defaults to 0.
|
||||
|
||||
=item high
|
||||
=head3 high
|
||||
|
||||
The highest possible value. Defaults to 1.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub randint {
|
||||
|
|
@ -224,14 +196,10 @@ sub randint {
|
|||
|
||||
Resorts an array in random order.
|
||||
|
||||
=over
|
||||
|
||||
=item array
|
||||
=head3 array
|
||||
|
||||
A reference to the array to randomize.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub randomizeArray {
|
||||
|
|
@ -251,14 +219,10 @@ sub randomizeArray {
|
|||
|
||||
Resorts a hash tied to IxHash in random order. Returns a hash reference.
|
||||
|
||||
=over
|
||||
|
||||
=item hashRef
|
||||
=head3 hashRef
|
||||
|
||||
A reference hash to randomize.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub randomizeHash {
|
||||
|
|
@ -278,19 +242,15 @@ sub randomizeHash {
|
|||
|
||||
Returns an integer after rounding a floating point number.
|
||||
|
||||
=over
|
||||
|
||||
=item float
|
||||
=head3 float
|
||||
|
||||
Any floating point number.
|
||||
|
||||
=item significantDigits
|
||||
=head3 significantDigits
|
||||
|
||||
The number of digits to leave after the decimal point. Defaults to 0.
|
||||
|
||||
NOTE: If you set this higher than 0 then you'll get back another floating point number rather than an integer.
|
||||
|
||||
=back
|
||||
B<NOTE:> If you set this higher than 0 then you'll get back another floating point number rather than an integer.
|
||||
|
||||
=cut
|
||||
|
||||
|
|
@ -305,14 +265,10 @@ sub round {
|
|||
|
||||
Sorts a hash by its values. Returns a hash.
|
||||
|
||||
=over
|
||||
|
||||
=item hash
|
||||
=head3 hash
|
||||
|
||||
A hash to be sorted.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
sub sortHash {
|
||||
|
|
@ -330,14 +286,10 @@ sub sortHash {
|
|||
|
||||
Sorts a hash in decending order by its values. Returns a hash.
|
||||
|
||||
=over
|
||||
|
||||
=item hash
|
||||
=head3 hash
|
||||
|
||||
A hash to be sorted.
|
||||
|
||||
=back
|
||||
|
||||
=cut
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue