diff --git a/lib/Pod/Block.pod b/lib/Pod/Block.pod new file mode 100644 index 000000000..e81a0c103 --- /dev/null +++ b/lib/Pod/Block.pod @@ -0,0 +1,40 @@ +=begin pod + +=TITLE class Pod::Block + + class Pod::Block { } + +Class for a Pod block, and base class for most other Pod classes. + +A Pod block has contents (more pod blocks or strings) and a config hash. + +Useful subclasses: + +=begin table + + Class Used for + ===== ======== + L paragraphs + L named blocks + L code blocks + L comments + L =head1 etc. headings + L list items + +=end table + +=head1 Methods + +=head2 contents + + method contents() returns Positional:D + +Returns a list of contents of this block. + +=head2 config + + method config returns EnumMap:D + +Returns a hash of configs. + +=end pod diff --git a/lib/Pod/Block/Code.pod b/lib/Pod/Block/Code.pod new file mode 100644 index 000000000..4a130959a --- /dev/null +++ b/lib/Pod/Block/Code.pod @@ -0,0 +1,17 @@ +=begin pod + +=TITLE class Pod::Block::Code + + class Pod::Block::Code is Pod::Block { } + +Class for a code (verbatim) Pod block. + +=head1 Methods + +=head2 allowed + + method allowed() returns Positional:D + +Returns a list of formatting codes that are allowed inside the code block. + +=end pod diff --git a/lib/Pod/Block/Named.pod b/lib/Pod/Block/Named.pod new file mode 100644 index 000000000..f411a60a6 --- /dev/null +++ b/lib/Pod/Block/Named.pod @@ -0,0 +1,23 @@ +=begin pod + +=TITLE class Pod::Block::Named + + class Pod::Block::Named is Pod::Block { } + +Class for a named Pod block. For example + + =begin mysection + ... + =end mysection + +creates a C with name C. + +=head1 Methods + +=head2 name + + method name() returns Str:D + +Returns the name of the block. + +=end pod diff --git a/lib/Pod/Block/Para.pod b/lib/Pod/Block/Para.pod new file mode 100644 index 000000000..a7a5473b1 --- /dev/null +++ b/lib/Pod/Block/Para.pod @@ -0,0 +1,9 @@ +=begin pod + +=TITLE class Pod::Block::Para + + class Pod::Block::Para is Pod::Block { } + +Class for a Pod paragraph. + +=end pod diff --git a/lib/Pod/Item.pod b/lib/Pod/Item.pod new file mode 100644 index 000000000..f213594b6 --- /dev/null +++ b/lib/Pod/Item.pod @@ -0,0 +1,17 @@ +=begin pod + +=TITLE class Pod::Item + + class Pod::Item is Pod::Block + +Class for items in Pod enumeration lists. + +=head1 Methods + +=head2 level + + method level() returns Int + +Returns the level of the enumeration list, starting at 1. + +=end pod