Vincenzo Zocca > PerlBean-1.0 > PerlBean::Described::ExportTag

Download:
PerlBean-1.0.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.0   Source  

NAME ^

PerlBean::Described::ExportTag - Tag description

SYNOPSIS ^

TODO

ABSTRACT ^

Generic described object

DESCRIPTION ^

PerlBean::Described::ExportTag describes export tags for pod generation in PerlBean objects.

CONSTRUCTOR ^

new(OPT_HASH_REF)

Creates a new PerlBean::Described::ExportTag object. OPT_HASH_REF is a hash reference used to pass initialization options. OPT_HASH_REF is mandatory. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF may include:

export_tag_name

Passed to set_export_tag_name(). Mandatory option.

Options for OPT_HASH_REF inherited through package PerlBean::Described may include:

description

Passed to set_description().

METHODS ^

get_description()

This method is inherited from package PerlBean::Described. Returns the description.

get_export_tag_name()

Returns tag's name.

set_description(VALUE)

This method is inherited from package PerlBean::Described. Set the description. VALUE is the value. On error an exception Error::Simple is thrown.

set_export_tag_name(VALUE)

Set tag's name. VALUE is the value. VALUE may not be undef. On error an exception Error::Simple is thrown.

VALUE must match regular expression:
^\w+$

SEE ALSO ^

PerlBean, PerlBean::Attribute, PerlBean::Attribute::Boolean, PerlBean::Attribute::Factory, PerlBean::Attribute::Multi, PerlBean::Attribute::Multi::Ordered, PerlBean::Attribute::Multi::Unique, PerlBean::Attribute::Multi::Unique::Associative, PerlBean::Attribute::Multi::Unique::Associative::MethodKey, PerlBean::Attribute::Multi::Unique::Ordered, PerlBean::Attribute::Single, PerlBean::Collection, PerlBean::Dependency, PerlBean::Dependency::Import, PerlBean::Dependency::Require, PerlBean::Dependency::Use, PerlBean::Described, PerlBean::Method, PerlBean::Method::Constructor, PerlBean::Method::Factory, PerlBean::Style, PerlBean::Symbol

BUGS ^

None known (yet.)

HISTORY ^

First development: March 2003 Last update: September 2003

AUTHOR ^

Vincenzo Zocca

COPYRIGHT ^

Copyright 2003 by Vincenzo Zocca

LICENSE ^

This file is part of the PerlBean module hierarchy for Perl by Vincenzo Zocca.

The PerlBean module hierarchy 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.

The PerlBean module hierarchy 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 the PerlBean module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

syntax highlighting: