|parrotcode: Documentation item|
|Contents | Perl Modules|
Parrot::Docs::Item - Documentation item
A documentation item is one or more related paths with some optional descriptive text.
Directory paths will be expanded to all the file paths within the directory and any subdirectories recursively (see the
files() method in
If an item has more than one file associated with it, and has no text, then an attempt will be made to extract short descriptions from each file to place under the file path in the index HTML.
$textshould be an empty string.
@contentswill be interpreted as being relative to the
write_html(). There should be at least one path otherwise an exception is raised.
write_html($source, $target, $silent)
$sourceis the directory in which the section's contents will be looked for.
$targetis directory into which the section's output will be written.
$silentis true then progress is not reported.
$targetand an HTML link is created to it.
is_docs_link()then an HTML link is created to the file itself.
$pathis an immediate subdirectory of
$source, then this method returns all the file paths within the directory and any subdirectories recursively, relative to
$pathis a file in
$pathcannot be found then a warning is printed.