HeaderDoc::Constant

Declared In:

Introduction

API object that describes a standalone constant.

Discussion

This class is used to represent constants that are not part of a typedef or enumeration. There is very little useful distinction between this and the Var class.

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 a Constant object.
clone: Duplicates this Constant object into another one.
printObject: Prints the object's fields for debugging purposes.
setDeclaration: Sets the declaration.

_initialize

Initializes an instance of a Constant object.

sub _initialize

Parameters

self: The object to initialize.

clone

Duplicates this Constant object into another one.

sub clone

Parameters

self: The object to clone.
clone: The victim object.

printObject

Prints the object's fields for debugging purposes.

sub printObject

Parameters

self: The Constant object.

setDeclaration

Sets the declaration.

sub setDeclaration

Parameters

self: The constant object.
declaration: The line array.

Member Data

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

HeaderDoc::Constant::VERSION

The revision control revision number for this module.

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

Discussion

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

Last Updated: Saturday, August 06, 2016