diff options
| author | Pascal Rigaux <pixel@mandriva.com> | 2001-07-25 12:51:06 +0000 |
|---|---|---|
| committer | Pascal Rigaux <pixel@mandriva.com> | 2001-07-25 12:51:06 +0000 |
| commit | b165dd5a00c6c3ac0050b34d0b7ed45a59607986 (patch) | |
| tree | b18197f0ab947993bb9890dd7c7858b864ec34f6 /MDK | |
| parent | e5967a4d74e730f06b14994fdacde370ce96bba3 (diff) | |
| download | perl_checker-b165dd5a00c6c3ac0050b34d0b7ed45a59607986.tar perl_checker-b165dd5a00c6c3ac0050b34d0b7ed45a59607986.tar.gz perl_checker-b165dd5a00c6c3ac0050b34d0b7ed45a59607986.tar.bz2 perl_checker-b165dd5a00c6c3ac0050b34d0b7ed45a59607986.tar.xz perl_checker-b165dd5a00c6c3ac0050b34d0b7ed45a59607986.zip | |
add documentation
Diffstat (limited to 'MDK')
| -rw-r--r-- | MDK/Common.pm | 42 | ||||
| -rw-r--r-- | MDK/Common/Globals.pm | 10 |
2 files changed, 47 insertions, 5 deletions
diff --git a/MDK/Common.pm b/MDK/Common.pm index dbc161c..5819b01 100644 --- a/MDK/Common.pm +++ b/MDK/Common.pm @@ -1,3 +1,45 @@ +=head1 NAME + +MDK::Common - miscellaneous functions + +=head1 SYNOPSIS + + use MDK::Common; + # exports all functions, equivalent to + + use MDK::Common::DataStructure qw(:all); + use MDK::Common::File qw(:all); + use MDK::Common::Func qw(:all); + use MDK::Common::Math qw(:all); + use MDK::Common::String qw(:all); + use MDK::Common::System qw(:all); + use MDK::Common::Various qw(:all); + +=head1 DESCRIPTION + +C<MDK::Common> is a collection of packages containing various simple functions: +L<MDK::Common::DataStructure>, +L<MDK::Common::File>, +L<MDK::Common::Func>, +L<MDK::Common::Globals>, +L<MDK::Common::Math>, +L<MDK::Common::String>, +L<MDK::Common::System>, +L<MDK::Common::Various>. + +=head1 EXPORTS + +C<MDK::Common> exports the functions in the package mentioned above. See their +manpage for more. + +=head1 COPYRIGHT + +Copyright (c) 2001 MandrakeSoft <pixel@mandrakesoft.com>. All rights reserved. +This program is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. + +=cut + package MDK::Common; use MDK::Common::DataStructure qw(:all); diff --git a/MDK/Common/Globals.pm b/MDK/Common/Globals.pm index 32a4fc1..15ca219 100644 --- a/MDK/Common/Globals.pm +++ b/MDK/Common/Globals.pm @@ -4,11 +4,11 @@ Shares constant values between modules =head1 SYNOPSIS -use MDK::Common::Globals "foo", qw($a $b); - -MDK::Common::Globals::init(a => 2, b => 3); - -print $a; # 2 + use MDK::Common::Globals "foo", qw($a $b); + + MDK::Common::Globals::init(a => 2, b => 3); + + print $a; # 2 =cut |