aboutsummaryrefslogtreecommitdiff
path: root/devel/p5-Pod-Tests/pkg-descr
diff options
context:
space:
mode:
Diffstat (limited to 'devel/p5-Pod-Tests/pkg-descr')
-rw-r--r--devel/p5-Pod-Tests/pkg-descr19
1 files changed, 19 insertions, 0 deletions
diff --git a/devel/p5-Pod-Tests/pkg-descr b/devel/p5-Pod-Tests/pkg-descr
new file mode 100644
index 000000000000..9c9c148802af
--- /dev/null
+++ b/devel/p5-Pod-Tests/pkg-descr
@@ -0,0 +1,19 @@
+This is a specialized POD viewer to extract embedded tests and code
+examples from POD. It doesn't do much more than that. pod2test does the
+useful work.
+
+After creating a Pod::Tests object, you parse the POD by calling one of
+the available parsing methods documented below. You can call parse as many
+times as you'd like, all examples and tests found will stack up inside the
+object.
+
+Once extracted, the tests can be built into stand-alone testing code using
+the build_tests() and build_examples() methods. However, it is recommended
+that you first look at the pod2test program before embarking on this.
+
+WWW: http://search.cpan.org/dist/Pod-Tests
+Author: Michael G Schwern <schwern@pobox.com>
+
+--
+Aaron Dalton
+aaron@FreeBSD.org