NAME
Parrot::Docs::Group - Group of documentation items
SYNOPSIS
use Parrot::Docs::Group;
DESCRIPTION
A documentation group is a number of items with some optional descriptive text.
Parrot::Docs::Group is a subclass of Parrot::Docs::Item.
Class Methods
new_group($name, $text, @items)
Returns a new group.Use this when creating groups within a new($name, $text, @contents)
Returns a new group.
Parrot::Docs::Section subclass's new() method.
$name and $text are required, though the text can be an empty string. @contents is one or more Parrot::Docs::Item instances, or relative paths.Instance Methods
name()
Returns the name of the group.
html_link()
Groups have no HTML link. This method returns an empty string which will be discarded when building the navigation bar.
write_html($source, $target, $silent)write_contents_html($source, $target, $silent)
Iterates over the group's contents and calls contents_relative_to_source($source)
Returns the contents of the group interpreted relative to the source directory.
write_html() is called on each item in the group.Some HTML-formatted text describing the files linked to is returned.
write_html() on each one.Some HTML-formatted text describing the files linked to is returned.