HeaderDoc::Method

Introduction

API object that describes an Objective-C method.

Discussion

The Method class stores information relating to an Objective-C method declaration.

This class is a subclass of HeaderElement. The majority of related fields and functions can be found there.

Member Functions

_initialize

Initializes an instance of a Method object.

clone

Duplicates this Method object into another one.

conflict

Sets/gets whether this symbol name has multiple variants with different numbers of arguments.

isInstanceMethod

Returns a cached indication of whether this is an instance method or a class method.

printObject

Prints this object for debugging purposes.

setDeclaration

Sets the declaration.

setIsInstanceMethod

Sets a flag to indicate whether this is an instance method or a class method.

_initialize

Initializes an instance of a Method object.

sub _initialize 

Parameters

clone

Duplicates this Method object into another one.

sub clone 

Parameters

conflict

Sets/gets whether this symbol name has multiple variants with different numbers of arguments.

sub conflict 

Parameters

Discussion

This method is basically nonsensical now that this object is used exclusively for Objective-C methods. Still, for compatibility, it remains (for now).

isInstanceMethod

Returns a cached indication of whether this is an instance method or a class method.

sub isInstanceMethod 

Parameters

Return Value

Returns YES or NO. Do not count on the specific values. This is subject to change.

printObject

Prints this object for debugging purposes.

sub printObject 

Parameters

setDeclaration

Sets the declaration.

sub setDeclaration 

Parameters

setIsInstanceMethod

Sets a flag to indicate whether this is an instance method or a class method.

sub setIsInstanceMethod 

Parameters

Member Data

CONFLICT

Set high (1) if this function conflicts with another function of the same name. This causes the method signature to be shown.

HeaderDoc::Method::VERSION

The revision control revision number for this module.

ISINSTANCEMETHOD

Set to YES if this function is an instance method, else NO for a class method.

RESULT

The contents of the @result or @return(s) tags.

CONFLICT

Set high (1) if this function conflicts with another function of the same name. This causes the method signature to be shown.

$self->{CONFLICT}

HeaderDoc::Method::VERSION

The revision control revision number for this module.

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

Discussion

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

ISINSTANCEMETHOD

Set to YES if this function is an instance method, else NO for a class method.

$self->{ISINSTANCEMETHOD}

RESULT

The contents of the @result or @return(s) tags.

$self->{RESULT}