HeaderDoc::CPPClass

Introduction

API object that describes most classes, modules, and packages.

Discussion

This class is used to represent classes, modules, and packages in every supported language except Objective-C.

This class is also used to represent COM interfaces in C.

Member Functions

_initialize

Initializes an instance of a CPPClass object.

clone

Duplicates this CPPClass object into another one.

docNavigatorComment

Returns a comment marker for gatherHeaderDoc.

isCOMInterface

Gets/sets whether this class is a COM interface (0/1).

printObject

Prints this object for debugging.

_initialize

Initializes an instance of a CPPClass object.

sub _initialize 

Parameters

clone

Duplicates this CPPClass object into another one.

sub clone 

Parameters

docNavigatorComment

Returns a comment marker for gatherHeaderDoc.

sub docNavigatorComment 

Parameters

Discussion

Returns an HTML comment that identifies the index file (Header vs. Class, name, and so on). The gatherHeaderDoc tool uses this information to create a master TOC for the generated doc.

isCOMInterface

Gets/sets whether this class is a COM interface (0/1).

sub isCOMInterface 

printObject

Prints this object for debugging.

sub printObject 

Parameters

Member Data

HeaderDoc::CPPClass::VERSION

The revision control revision number for this module.

ISCOMINTERFACE

Set high (1) if this object represents a C COM interface, else low (0).

HeaderDoc::CPPClass::VERSION

The revision control revision number for this module.

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

Discussion

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

ISCOMINTERFACE

Set high (1) if this object represents a C COM interface, else low (0).

$self->{ISCOMINTERFACE}