Testsuite: Add POD to Exim::Runtest
authorHeiko Schlittermann (HS12-RIPE) <hs@schlittermann.de>
Thu, 3 Nov 2016 09:14:54 +0000 (10:14 +0100)
committerHeiko Schlittermann (HS12-RIPE) <hs@schlittermann.de>
Thu, 3 Nov 2016 09:14:54 +0000 (10:14 +0100)
test/lib/Exim/Runtest.pm

index 1df2ea1..e60fce1 100644 (file)
@@ -6,10 +6,22 @@ use Carp;
 
 use List::Util qw'shuffle';
 
+=head1 NAME
+
+Exim::Runtest - helper functions for the runtest script
+
+=head1 SYNOPSIS
+
+ use Exim::Runtest;
+ my $foo = Exim::Runtest::foo('foo');
+
+=head1 DESCRIPTION
+
+The B<Exim::Runtest> module provides some simple functions
+for the F<runtest> script. No functions are exported yet.
+
+=cut
 
-# find a group name, preferrable 'mail', but
-# use some other random name if 'mail' isn't a valid group
-# name
 sub mailgroup {
     my $group = shift;
 
@@ -39,3 +51,23 @@ sub dynamic_socket {
 }
 
 1;
+
+__END__
+
+=head1 FUNCTIONS
+
+=over
+
+=item B<mailgroup>(I<$default>)
+
+Check if the mailgroup I<$default> exists. Return the checked
+group name or some other random but existing group.
+
+=item B<dynamic_socket>()
+
+Return a dynamically allocated listener socket in the range
+between 1024 and 65534;
+
+=back
+
+=cut