HeaderDoc::AvailHelper

Declared In:

AvailHelper.pm

Introduction

AvailHelper Class

The AvailHelper class generates hash tables related to availability macros.

_initialize: Initializes an instance of an AvailHelper object.
_initVersionHash: Initializes and returns a hash that maps availabity tokens to version numbers.
_initVersionStringHash: Initializes and returns a hash that maps version numbers to human-readable availability strings.
new: Creates a new AvailHelper object.
parseString: Tears apart an availbility macro token string and converts to a human-readable availability string.
versionnum: Converts an availability token to a version number.
versionstring: Converts a version number to a human-readable availability string.

Initializes an instance of an AvailHelper object.

sub _initialize

Initializes and returns a hash that maps availabity tokens to version numbers.

sub _initVersionHash()

Initializes and returns a hash that maps version numbers to human-readable availability strings.

sub _initVersionStringHash()

Creates a new AvailHelper object.

sub new

param: A reference to the relevant package object (e.g. HeaderDoc::AvailHelper->new() to allocate a new instance of this class).

Tears apart an availbility macro token string and converts to a human-readable availability string.

sub parseString

Converts an availability token to a version number.

sub versionnum

Converts a version number to a human-readable availability string.

sub versionstring

HeaderDoc::AvailHelper::VERSION: The revision control revision number for this module.

The revision control revision number for this module.

$HeaderDoc::AvailHelper::VERSION = '$Revision: 1298084577 $';

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

Last Updated: Saturday, August 06, 2016