HeaderDoc::Typedef

Introduction

API object that that describes a type declaration.

Discussion

The Typedef class stores information relating to a type definition declaration.

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 Typedef object.

clone

Duplicates this Typedef object into another one.

fields

Gets/sets the array of fields that are associated with a struct or union (in a typedef).

isEnumList

Gets/sets a flag indicating that this typedef contains an enumeration (or at least is marked up with @const or @constant tags in the comment).

printObject

Prints this object for debugging purposes.

setDeclaration

Sets the declaration.

_initialize

Initializes an instance of a Typedef object.

sub _initialize 

Parameters

clone

Duplicates this Typedef object into another one.

sub clone 

Parameters

fields

Gets/sets the array of fields that are associated with a struct or union (in a typedef).

sub fields 

Parameters

isEnumList

Gets/sets a flag indicating that this typedef contains an enumeration (or at least is marked up with @const or @constant tags in the comment).

sub isEnumList 

Parameters

Return Value

Returns 0 or 1.

printObject

Prints this object for debugging purposes.

sub printObject 

Parameters

setDeclaration

Sets the declaration.

sub setDeclaration 

Parameters

Member Data

FIELDS

An array of fields in this structure. See fields.

HeaderDoc::Typedef::VERSION

The revision control revision number for this module.

ISENUMLIST

Contains 1 if this is an enumeration. See isEnumList.

ISFUNCPTR

Contains 1 if this is a function pointer. See isFunctionPointer.

RESULT

The contents of the @result or @return(s) tags.

FIELDS

An array of fields in this structure. See fields.

$self->{FIELDS}

HeaderDoc::Typedef::VERSION

The revision control revision number for this module.

$HeaderDoc::Typedef::VERSION = '$Revision: 1298084579 $';  

Discussion

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

ISENUMLIST

Contains 1 if this is an enumeration. See isEnumList.

$self->{ISENUMLIST}

ISFUNCPTR

Contains 1 if this is a function pointer. See isFunctionPointer.

$self->{ISFUNCPTR}

RESULT

The contents of the @result or @return(s) tags.

$self->{RESULT}