HeaderDoc::Header

Declared In:

Introduction

API object that describes a header file.

Discussion

This class is a subclass of APIOwner, which is a subclass of HeaderElement. The majority of related fields and functions can be found in those two classes.

Member Functions

_initialize: Initializes an instance of a Header object.
availability: Gets/sets the availability for the header.
docNavigatorComment: Returns a comment marker for gatherHeaderDoc.
fullpath: Gets/sets the full path of the header.
headerCopyrightOwner: Gets/sets the copyright owner info for a header.
HTMLmeta: Gets/appends to the HTML meta tag list for a header.
printObject: Prints an object for debugging purposes.
removeFromCategories: Removes one object from the categories list.
updated: Gets/sets the updated date for the header.
writeHeaderElementsToCompositePage: Writes the contents of a header object to a composite page.

_initialize

Initializes an instance of a Header object.

sub _initialize

Parameters

self: The object to initialize.

availability

Gets/sets the availability for the header.

sub availability

Parameters

self: The Header object.
value: The value to set. (Optional.)

docNavigatorComment

Returns a comment marker for gatherHeaderDoc.

sub docNavigatorComment

Parameters

self: The APIOwner object.

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.

fullpath

Gets/sets the full path of the header.

sub fullpath

Parameters

self: The Header object.
value: The value to set. (Optional.)

headerCopyrightOwner

Gets/sets the copyright owner info for a header.

sub headerCopyrightOwner

Parameters

self: The Header object.
value: The value to set. (Optional.)

HTMLmeta

Gets/appends to the HTML meta tag list for a header.

sub HTMLmeta

Parameters

self: The Header object.
value: The value to set. (Optional.)

printObject

Prints an object for debugging purposes.

sub printObject

Parameters

self: The Header object.

removeFromCategories

Removes one object from the categories list.

sub removeFromCategories

Parameters

self: The Header object.
object: The object to remove.

Discussion

A category gets removed if HeadeDoc finds the associated class and merges the category's methods into it.

updated

Gets/sets the updated date for the header.

sub updated

Parameters

self: The Header object.
value: The value to set. (Optional.)

writeHeaderElementsToCompositePage

Writes the contents of a header object to a composite page.

sub writeHeaderElementsToCompositePage

Parameters

self: The Header object.

Member Data

CATEGORIES: An array of categories in this header.
COPYRIGHT: The copyright information (from the @copyright tag) for this header.
FULLPATH: The (relative) path to this header, as specified on the command line.
HeaderDoc::Header::VERSION: The revision control revision number for this module.
HTMLMETA: HTML "meta" tags to add to this header's output.
PROTOCOLS: An array of protocols in this header.

COPYRIGHT

The copyright information (from the @copyright tag) for this header.

$self->{COPYRIGHT}

FULLPATH

The (relative) path to this header, as specified on the command line.

$self->{FULLPATH}

HeaderDoc::Header::VERSION

The revision control revision number for this module.

$HeaderDoc::Header::VERSION = '$Revision: 1306450222 $';

Discussion

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

HTMLMETA

HTML "meta" tags to add to this header's output.

$self->{HTMLMETA}

PROTOCOLS

An array of protocols in this header.

$self->{PROTOCOLS}

Last Updated: Saturday, August 06, 2016