/ 
Meta-0.08
River stage zero No dependents
/ Meta::Revision::Entry

NAME

Meta::Revision::Entry - a single revision of a source file entry.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

MANIFEST: Entry.pm
PROJECT: meta
VERSION: 0.20

SYNOPSIS

package foo;
use Meta::Revision::Entry qw();
my($object)=Meta::Revision::Entry->new();
my($result)=$object->printd($xml);

DESCRIPTION

This object represents a single revision entry in a list of revisions made to a source file. It has a couple of basic elements in it: the revisors initials, the revision number, the date of the revision and remarks that accompanied the revision.

You can print this revision data in various formats (Docbook) and other uses. The idea is that if you have a tool (like a Source Control system) which has revision information you would write import code which will create these types of object and then ask them to output themselves in whatever.

FUNCTIONS

BEGIN()
print($$)
printd($$)
string($)
perl_pod_line($$)
TEST($)

FUNCTION DOCUMENTATION

BEGIN()

This block sets up the Entry object which has the following attributes: number: the number of the current revision. date: date at which the revision was made. initials: initials of the author who made the revision. remark: short remark which accompanied the revision. action: which action did the revision perform (new, update, delete). change: with which change (piece of work or a formal definition of a source control system) was the revision associated ? delta: what was the number of the change with which the revision was associated with ?

print($$)

This method prints the revision object to a regular file.

printd($$)

This method will print the current object in DocBook XML format using a writer object received. Take heed that the DocBook DTD only allows revremark OR revdescription and not both.

string($)

This method will return a string representing the entire information for this entry.

perl_pod_line($$)

This method will return the revision entry in a manner suitable for insertion in a perl POD section.

TEST($)

Test suite for this module.

SUPER CLASSES

None.

BUGS

None.

AUTHOR

Name: Mark Veltzer
Email: mailto:veltzer@cpan.org
WWW: http://www.veltzer.org
CPAN id: VELTZER

HISTORY

0.00 MV more perl code quality
0.01 MV revision change
0.02 MV better general cook schemes
0.03 MV revision in files
0.04 MV languages.pl test online
0.05 MV history change
0.06 MV perl packaging
0.07 MV PDMT
0.08 MV md5 project
0.09 MV database
0.10 MV perl module versions in files
0.11 MV movies and small fixes
0.12 MV md5 progress
0.13 MV thumbnail project basics
0.14 MV thumbnail user interface
0.15 MV more thumbnail issues
0.16 MV website construction
0.17 MV web site development
0.18 MV web site automation
0.19 MV SEE ALSO section fix
0.20 MV md5 issues

SEE ALSO

Meta::Class::MethodMaker(3), Meta::Math::Pad(3), strict(3)

TODO

Nothing.