Update documentation and version

[gruntmaster-daemon.git] / lib / Gruntmaster / Daemon / Runner / Verifier.pm

diff --git a/lib/Gruntmaster/Daemon/Runner/Verifier.pm b/lib/Gruntmaster/Daemon/Runner/Verifier.pm
index 5a0b5ed5d9bb789e8263c658e8124e3fb15b44b2..070fd0a9b1d4057ff785e2a77a7431d8f390fbad 100644 (file)
--- a/lib/Gruntmaster/Daemon/Runner/Verifier.pm
+++ b/lib/Gruntmaster/Daemon/Runner/Verifier.pm
@@ -9,6 +9,8 @@ use File::Slurp qw/slurp/;
 use Log::Log4perl qw/get_logger/;
 use Try::Tiny;
 
+our $VERSION = '5999-TRIAL';
+
 ##################################################
 
 sub run{
@@ -24,4 +26,38 @@ sub run{
   scalar slurp 'result';
 }
 
-1
+1;
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+Gruntmaster::Daemon::Runner::Verifier - Check the program output with a verifier
+
+=head1 SYNOPSIS
+
+  use Gruntmaster::Daemon::Runner::Verifier;
+  Gruntmaster::Daemon::Runner::Verifier->run(5, $meta);
+
+=head1 DESCRIPTION
+
+Gruntmaster::Daemon::Runner::Verifier is a runner which uses a verifier program to check the correctness of the output.
+
+The verifier program, C<< $meta->{files}{ver} >>, reads the test input from stdin and the output from fd 3. If the output is incorrect, it should return a nonzero value. Otherwise, it should print the score on this test and then return 0.
+
+=head1 AUTHOR
+
+Marius Gavrilescu E<lt>marius@ieval.roE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2014 by Marius Gavrilescu
+
+This library is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+
+=cut