HeaderDoc::ObjCContainer

Introduction

Intermediate API object base class for Objective-C classes, categories, and protocols.

Discussion

This class is subclassed by ObjCClass, ObjCCategory, and ObjCProtocol.

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.

This API object type should never actually be emitted as output; only its subclasses are relevant.

Member Functions

_initialize

Initializes an instance of a ObjCContainer object.

conformsToList

Sets the list of protocols to which this class conforms.

docNavigatorComment

Returns a comment marker for gatherHeaderDoc.

getMethodPrefix

Returns +/- depending on whether a method is a class method or instance method.

printObject

Prints this object for debugging purposes.

_initialize

Initializes an instance of a ObjCContainer object.

sub _initialize 

Parameters

conformsToList

Sets the list of protocols to which this class conforms.

sub conformsToList 

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.

getMethodPrefix

Returns +/- depending on whether a method is a class method or instance method.

sub getMethodPrefix 

Parameters

printObject

Prints this object for debugging purposes.

sub printObject 

Parameters

Member Data

HeaderDoc::ObjCContainer::VERSION

The revision control revision number for this module.

HeaderDoc::ObjCContainer::VERSION

The revision control revision number for this module.

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

Discussion

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