NAME
OODoc::Manifest - maintain the information inside a manifest file.
INHERITANCE
OODoc::Manifest
is a OODoc::ObjectSYNOPSIS
my $manifest = OODoc::Manifest->new(filename => ...);DESCRIPTION
METHODS
overload: @{}
Referencing this object as array will produce all filenames from the manifest.
$obj->add(FILENAMES)
Adds the FILENAMES to the manifest, doubles are ignored.
$obj->filename
The name of the file which is read or will be written.
$obj->files
Returns an unsorted list with all filenames in this manifest.
$obj->modified([BOOLEAN])
Whether filenames have been added to the list after initiation.
$obj->read
Read the manifest file.
$obj->write
Write the MANIFEST file if it has changed. The file will automatically be written when the object leaves scope.
Initiation
OODoc::Manifest->new(OPTIONS)
Option Defined in Default
filename C<undef>. filename FILENAME
The filename where the manifest is in. When the name is not defined, the data will not be written.
Collected
$obj->extends([OBJECT])
Commonly used functions
$obj->filenameToPackage(FILENAME)
OODoc::Manifest->filenameToPackage(FILENAME)
$obj->mkdirhier(DIRECTORY)
OODoc::Manifest->mkdirhier(DIRECTORY)
Manual Repository
$obj->addManual(MANUAL)
$obj->mainManual(NAME)
$obj->manuals
$obj->manualsForPackage(NAME)
$obj->packageNames
DIAGNOSTICS
Error: Cannot read manifest file $filename: $!
The manifest file could not be opened for reading.
Error: manual definition requires manual object
A call to addManual() expects a new manual object (a OODoc::Manual), however an incompatible thing was passed. Usually, intended was a call to manualsForPackage() or mainManual().
REFERENCES
See the OODoc website at http://perl.overmeer.net/oodoc/ for more details.
COPYRIGHTS
Module version 0.04. Written by Mark Overmeer (mark@overmeer.net). See the ChangeLog for other contributors.
Copyright (c) 2003 by the author(s). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.