OODoc::Manifest - maintain the information inside a manifest file.
OODoc::Manifest is a OODoc::Object
my $manifest = OODoc::Manifest->new(filename => ...);
overload: @{}
Referencing this object as array will produce all filenames from the manifest.
OODoc::Manifest->new(OPTIONS)
Option Defined in Default filename undef
. filename FILENAME
The filename where the manifest is in. When the name is not defined, the data will not be written.
$obj->extends([OBJECT])
See "Inheritance knowledge" in OODoc::Object
$obj->filename
The name of the file which is read or will be written.
$obj->add(FILENAMES)
Adds the FILENAMES to the manifest, doubles are ignored.
$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->relative(FILENAME)
Returns the name of the file relative to the location of the MANIFEST file. The MANIFEST file should always be in top of the directory tree, so the FILENAME should be in the same directory and below.
$obj->write
Write the MANIFEST file if it has changed. The file will automatically be written when the object leaves scope.
$obj->filenameToPackage(FILENAME)
OODoc::Manifest->filenameToPackage(FILENAME)
See "Commonly used functions" in OODoc::Object
$obj->mkdirhier(DIRECTORY)
OODoc::Manifest->mkdirhier(DIRECTORY)
$obj->addManual(MANUAL)
See "Manual Repository" in OODoc::Object
$obj->mainManual(NAME)
$obj->manual(NAME)
$obj->manuals
$obj->manualsForPackage(NAME)
$obj->packageNames
Error: Cannot read manifest file $filename: $!
The manifest file could not be opened for reading.
Warning: MANIFEST file $name lists filename outside (sub)directory: $file
The MANIFEST file of a distributed package should be located in the top directory of that packages. All files of the distribution are in that same directory, or one of its sub-directories, otherwise they will not be packaged.
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().
See the OODoc website at http://perl.overmeer.net/oodoc/ for more details.
Module version 0.10. 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.
To install OODoc, copy and paste the appropriate command in to your terminal.
cpanm
cpanm OODoc
CPAN shell
perl -MCPAN -e shell install OODoc
For more information on module installation, please visit the detailed CPAN module installation guide.