summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Spek <p.spek@tyil.nl>2018-06-24 01:48:16 +0200
committerPatrick Spek <p.spek@tyil.nl>2018-06-24 01:48:16 +0200
commitec041f718bc90ddd5fab05cfa4a9cd9301f5e356 (patch)
treedbd2fbe93ab3242f0da9e51e5f9a06650451191e
parent9a6b471e00fa61b62db2271d55dc8f45b7e8c3d1 (diff)
downloadPod::To::Pager-ec041f718bc90ddd5fab05cfa4a9cd9301f5e356.tar.gz
Pod::To::Pager-ec041f718bc90ddd5fab05cfa4a9cd9301f5e356.tar.bz2
Add pod structures to some files
-rw-r--r--bin/p6man27
-rw-r--r--lib/Pod/To/Pager/BorderedBlock.pm632
2 files changed, 59 insertions, 0 deletions
diff --git a/bin/p6man b/bin/p6man
index 1a4c1cc..bfefb94 100644
--- a/bin/p6man
+++ b/bin/p6man
@@ -21,4 +21,31 @@ sub MAIN (
shell $command;
}
+=begin pod
+
+=NAME p6man
+=AUTHOR Patrick Spek <p.spek@tyil.work>
+=VERSION 0.1.0
+=LICENSE GNU Aferro General Public License, version 3
+
+=head1 Synopsis
+
+=item1 p6man --help
+=item1 p6man [--skip-pager] <file>
+
+=head1 Description
+
+C<p6man> is a Perl 6 utility to generate manual-like information on a Perl 6
+program or module, based on it's pod structure.
+
+=head1 Examples
+
+ p6man p6man
+
+=head1 See also
+
+=item1 L<p6doc|https://github.com/perl6/doc/blob/master/bin/p6doc>
+
+=end pod
+
# vim: ft=perl6 noet
diff --git a/lib/Pod/To/Pager/BorderedBlock.pm6 b/lib/Pod/To/Pager/BorderedBlock.pm6
index 06d2f58..844c913 100644
--- a/lib/Pod/To/Pager/BorderedBlock.pm6
+++ b/lib/Pod/To/Pager/BorderedBlock.pm6
@@ -103,4 +103,36 @@ class Pod::To::Pager::BorderedBlock
}
}
+=begin pod
+
+=NAME Pod::To::Pager::BorderedBlock
+=AUTHOR Patrick Spek
+=VERSION 0.1.0
+=LICENSE GNU Aferro General Public License, version 3
+
+=head1 Description
+
+This module is supporting for C<p6man>, to create the blocks of text surrounded
+by a border. It is intended to be seperated into it's own module later on.
+
+=head1 Examples
+
+=head2 Default usage
+
+=begin code
+use Pod::To::Pager::BorderedBlock;
+
+my Pod::To::Pager::BorderedBlock $block .= new;
+
+say $block.render("Some content to put a border around")
+=end code
+
+=begin output
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃Some content to put a border around ┃
+┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+=end output
+
+=end pod
+
# vim: ft=perl6 noet