HeaderDoc::ObjCProtocol

Introduction

API object that describes an Objective-C protocol.

Discussion

The ObjCProtocol class stores information relating to an Objective-C protocol.

This class is a subclass of ObjCContainer, which 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 ObjCProtocol object.

docNavigatorComment

Returns a comment marker for gatherHeaderDoc.

_initialize

Initializes an instance of a ObjCProtocol object.

sub _initialize 

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.

Member Data

HeaderDoc::ObjCProtocol::VERSION

The revision control revision number for this module.

HeaderDoc::ObjCProtocol::VERSION

The revision control revision number for this module.

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

Discussion

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