HeaderDoc::ObjCCategory

Declared In:

Introduction

API object that describes an Objective-C category.

Discussion

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 ObjCCategory object.
categoryName: Splits the raw name out into separate class and category fields. Returns the category name portion.
className: Splits the raw name out into separate class and category fields. Returns the class name portion.
docNavigatorComment: Returns a comment marker for gatherHeaderDoc.
getClassAndCategoryName: Splits the raw name out into separate class and category fields. Returns them in an array.
printObject: Prints this object for debugging purposes.

_initialize

Initializes an instance of a ObjCCategory object.

sub _initialize

Parameters

self: The object to initialize.

categoryName

Splits the raw name out into separate class and category fields. Returns the category name portion.

sub categoryName

Parameters

self: This object.

className

Splits the raw name out into separate class and category fields. Returns the class name portion.

sub className

Parameters

self: This object.

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.

getClassAndCategoryName

Splits the raw name out into separate class and category fields. Returns them in an array.

sub getClassAndCategoryName

Parameters

fullName: The full name line for this category (from a call to $self->name()).
fullpath: The full path of this header (from a call to $self->fullpath()).
linenum: The line number of this object (from a call to $self->linenum()).

printObject

Prints this object for debugging purposes.

sub printObject

Parameters

self: This object.

Member Data

HeaderDoc::ObjCCategory::VERSION: The revision control revision number for this module.

HeaderDoc::ObjCCategory::VERSION

The revision control revision number for this module.

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

Discussion

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

Last Updated: Saturday, August 06, 2016