HeaderDoc::Enum

Declared In:

Introduction

API object that that describes an enumeration declaration.

Discussion

This class is a subclass of HeaderElement. The majority of related fields and functions can be found there.


Member Functions

_initialize

Initializes an instance of an Enum object.

clone

Duplicates this Enum object into another one.

getEnumDeclaration

Legacy formatter for Enum declarations.

printObject

Prints this object for debugging purposes.

_initialize

Initializes an instance of an Enum object. 

sub _initialize
Parameters
self

The object to initialize.

clone

Duplicates this Enum object into another one. 

sub clone
Parameters
self

The object to clone.

clone

The victim object.

getEnumDeclaration

Legacy formatter for Enum declarations. 

sub getEnumDeclaration
Parameters
self

The Enum object.

dec

The raw input declaration.

Discussion

This usually just returns the declaration (for performance reasons) because the declaration is going to be thrown away anyway.

This should probably go away eventually.

printObject

Prints this object for debugging purposes. 

sub printObject
Parameters
self

This object.

Member Data

HeaderDoc::Enum::VERSION

The revision control revision number for this module.

HeaderDoc::Enum::VERSION

The revision control revision number for this module. 

$HeaderDoc::Enum::VERSION = '$Revision: 1298084578 $';
Discussion

In the git repository, contains the number of seconds since January 1, 1970.

 

Last Updated: Saturday, August 06, 2016