HeaderDoc::IncludeHash

Declared In:

Introduction

Stores the content and line number of an include directive.

Discussion

The IncludeHash class is basically used as a data structure without accessor methods.

This class stores where a particular #include directive appears within a header file. Each header file has an array containing one IncludeHash instance for each header that it includes.

Member Functions

_initialize: Initializes an instance of an IncludeHash object.
new: Creates a new IncludeHash object.

new

Creates a new IncludeHash object.

sub new

Parameters

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

Member Data

FILENAME: The filename (and leading path parts) included at a particular line number.
HASHREF: The HeaderDoc::HeaderFileCPPHashHash hash for the file specified by FILENAME, which in turn comes from the CPP_HASH in BlockParse. This includes the C preprocessor tokens defined by the file in question.
HeaderDoc::IncludeHash::VERSION: The revision control revision number for this module.
LINENUM: The line number at which the include statement appears.

FILENAME

The filename (and leading path parts) included at a particular line number.

$self->{FILENAME}

The HeaderDoc::HeaderFileCPPHashHash hash for the file specified by FILENAME, which in turn comes from the CPP_HASH in BlockParse. This includes the C preprocessor tokens defined by the file in question.

$self->{HASHREF}