NAME

Meta::Baseline::Utils - library to provide utilities to baseline software.

COPYRIGHT

Copyright (C) 2001 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: Utils.pm PROJECT: meta

SYNOPSIS

package foo; use Meta::Baseline::Utils qw(); Meta::Baseline::Utils::cook_emblem_print(*FILE);

DESCRIPTION

This package will provide code sniplets that a lot of scripts in the baseline need.

EXPORTS

get_emblem() get_cook_emblem() file_emblem($) script_emblem($) xmlfile_emblem($) cook_emblem($) cook_emblem_print($)

FUNCTION DOCUMENTATION

get_emblem()

This will return the emblem that should be put on auto generated files.

get_cook_emblem()

This method returns the emblem in a cook style (C multi line comment).

file_emblem($)

This will create a stub file with the emblem. This is meant for files in which the /* */ is the form for comments.

script_emblem($)

This method will create a stub file fit for scripts (where the hash (#) sign is the correct form for comments.

xmlfile_emblem($)

This will create a stub XML file.

cook_emblem($)

Cook knows how to handle C++ style comments so we just call the method for that.

cook_emblem_print($)

This method gets a file handle and prints a cook emblem into it.

BUGS

None.

AUTHOR

Mark Veltzer <mark2776@yahoo.com>

HISTORY

start of revision info end of revision info

SEE ALSO

Nothing.

TODO

-add routine to make a file read only after is created and do it with emblem.

-make the emblem / emblem_simple more natural.