Skip to content
Browse files

Doc stuff

  • Loading branch information...
1 parent 5a39552 commit 6df342da62f189dd79b8437027df0ea185c95346 @exodist committed Jan 23, 2011
View
1 TODO
@@ -1,2 +1,3 @@
* Mocking - Object::Quick
* TB2 support
+ * Fennec::Declare
View
9 lib/Fennec.pm
@@ -4,7 +4,7 @@ use warnings;
use Fennec::Util qw/inject_sub/;
-our $VERSION = '0.100';
+our $VERSION = '1.000_1';
sub defaults {(
utils => [qw/
@@ -114,6 +114,13 @@ Fennec started as a project to improve the state of testing in Perl. Fennec
looks to existing solutions for most problems, so long as the existing
solutions help meet the features listed below.
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
=head1 FEATURES
=over 4
View
57 lib/Fennec/Listener.pm
@@ -10,3 +10,60 @@ sub diag { croak "You must subclass diag() in your listener(" . shift(@_) . ")"
sub terminate {}
1;
+
+__END__
+
+=head1 NAME
+
+Fennec::Listener - Base class for Fennec listeners.
+
+=head1 DESCRIPTION
+
+Override this to create a new listener.
+
+=head1 METHODS TO OVERRIDE
+
+=over 4
+
+=item $class->new()
+
+Create a new instance of the listener, takes no arguments.
+
+=item $obj->ok( $status, $name)
+
+Sometimes Fennec needs to produce test results, it will turn to the listener to
+do so. This should be just like Test::More's ok() method. Most listeners should
+simply pass this on to Test::Builder.
+
+=item $obj->diag( @messages )
+
+Sometimes Fennec needs to produce test results, it will turn to the listener to
+do so. This should be just like Test::More's diag() method. Most listeners
+should simply pass this on to Test::Builder.
+
+=item $obj->terminate()
+
+Called when the master process is about to exit.
+
+=back
+
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.
View
27 lib/Fennec/Listener/TB.pm
@@ -191,3 +191,30 @@ sub DESTROY {
}
1;
+
+__END__
+
+=head1 NAME
+
+=head1 DESCRIPTION
+
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.
View
33 lib/Fennec/Listener/TB/Handle.pm
@@ -25,21 +25,30 @@ sub PRINT {
}
1;
+
__END__
- my $original_print = Test::Builder->can('_print_to_fh');
- *Test::Builder::_print_to_fh = sub {
- my( $tb, $fh, @msgs ) = @_;
+=head1 NAME
- my ( $handle, $output );
- open( $handle, '>', \$output );
- $original_print->( $tb, $handle, @msgs );
- close( $handle );
+=head1 DESCRIPTION
- my $ohandle = ($fh == $tb->output) ? 'STDOUT' : 'STDERR';
+=head1 API STABILITY
- my @call = get_test_call();
- print $out join( "\0", $$, $ohandle, $call[0], $call[1], $call[2], $_ ) . "\n"
- for split( /[\n\r]+/, $output );
- };
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.
View
27 lib/Fennec/Listener/TB2.pm
@@ -11,3 +11,30 @@ sub ok {}
sub terminate {}
1;
+
+__END__
+
+=head1 NAME
+
+=head1 DESCRIPTION
+
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.
View
27 lib/Fennec/Meta.pm
@@ -16,3 +16,30 @@ sub new {
}
1;
+
+__END__
+
+=head1 NAME
+
+=head1 DESCRIPTION
+
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.
View
27 lib/Fennec/Runner.pm
@@ -126,3 +126,30 @@ sub exception {
}
1;
+
+__END__
+
+=head1 NAME
+
+=head1 DESCRIPTION
+
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.
View
27 lib/Fennec/Util.pm
@@ -48,3 +48,30 @@ sub get_test_call {
}
1;
+
+__END__
+
+=head1 NAME
+
+=head1 DESCRIPTION
+
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.
View
27 lib/Test/Workflow.pm
@@ -169,3 +169,30 @@ sub get_tests {
}
1;
+
+__END__
+
+=head1 NAME
+
+=head1 DESCRIPTION
+
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.
View
27 lib/Test/Workflow/Block.pm
@@ -85,3 +85,30 @@ sub run {
}
1;
+
+__END__
+
+=head1 NAME
+
+=head1 DESCRIPTION
+
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.
View
27 lib/Test/Workflow/Layer.pm
@@ -68,3 +68,30 @@ sub get_all {
}
1;
+
+__END__
+
+=head1 NAME
+
+=head1 DESCRIPTION
+
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.
View
27 lib/Test/Workflow/Meta.pm
@@ -18,3 +18,30 @@ sub new {
}
1;
+
+__END__
+
+=head1 NAME
+
+=head1 DESCRIPTION
+
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.
View
27 lib/Test/Workflow/Test.pm
@@ -62,3 +62,30 @@ sub _wrap_tests {
}
1;
+
+__END__
+
+=head1 NAME
+
+=head1 DESCRIPTION
+
+=head1 API STABILITY
+
+Fennec versions below 1.000 were considered experimental, and the API was
+subject to change. As of version 1.0 the API is considered stabalized. New
+versions may add functionality, but not remove or significantly alter existing
+functionality.
+
+=head1 AUTHORS
+
+Chad Granum L<exodist7@gmail.com>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2011 Chad Granum
+
+Fennec is free software; Standard perl licence.
+
+Fennec is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the license for more details.

0 comments on commit 6df342d

Please sign in to comment.
Something went wrong with that request. Please try again.