HeaderDoc::Group

Introduction

Stores information about a group of symbols.

Discussion

A new instance of Group is created for each distinct name value in the @group, @functiongroup, or @vargroup tag (if the @vargroup tag is used in a class or header 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 Group object.

clone

Duplicates this Group object into another one.

printObject

Prints this object for debugging purposes.

processComment

Processes the comment for an @group tag.

_initialize

Initializes an instance of a Group object.

sub _initialize 

Parameters

clone

Duplicates this Group object into another one.

sub clone 

Parameters

printObject

Prints this object for debugging purposes.

sub printObject 

Parameters

processComment

Processes the comment for an @group tag.

sub processComment 

Parameters

Member Data

HeaderDoc::Group::VERSION

The revision control revision number for this module.

MEMBEROBJECTS

A reference to an array of objects that are a member of this group.

HeaderDoc::Group::VERSION

The revision control revision number for this module.

$HeaderDoc::Group::VERSION = '$Revision: 1298084578 $';  

Discussion

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

MEMBEROBJECTS

A reference to an array of objects that are a member of this group.

$self->{MEMBEROBJECTS}