HeaderDoc::Function

Declared In:

Introduction

API object that describes a function declaration.

Discussion

The Function class stores information relating to a function declaration. It is also used for methods except in Objective-C. Objective-C methods use the Method class.

The Function 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 Function object.
clone: Duplicates this Function object into another one.
conflict: Gets/sets whether this function has a conflict with another function of the same name.
getParamSignature: Gets the parameter signature for a function.
printObject: Prints an object for debugging purposes.
sanitizedreturntype: Strips out keywords like static from the return type.
setDeclaration: Sets the declaration.

_initialize

Initializes an instance of a Function object.

sub _initialize

Parameters

self: The object to initialize.

clone

Duplicates this Function object into another one.

sub clone

Parameters

self: The object to clone.
clone: The victim object.

conflict

Gets/sets whether this function has a conflict with another function of the same name.

sub conflict

Parameters

self: The Function object.
conflict: The value to set. (Optional.)

getParamSignature

Gets the parameter signature for a function.

sub getParamSignature

Parameters

self: The Function object.

printObject

Prints an object for debugging purposes.

sub printObject

Parameters

self: The Function object.

sanitizedreturntype

Strips out keywords like static from the return type.

sub sanitizedreturntype

Parameters

self: The Function object from which the return type should be obtained.

Discussion

Some keywords prior to a function name modify the function as a whole, not the return type. These keywords should never be part of the return type.

setDeclaration

Sets the declaration.

sub setDeclaration

Parameters

self: This object.
declaration: The line array.

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::Function::VERSION: The revision control revision number for this module.
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::Function::VERSION

The revision control revision number for this module.

$HeaderDoc::Function::VERSION = '$Revision: 1299283925 $';

Discussion

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

RESULT

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

$self->{RESULT}

Last Updated: Saturday, August 06, 2016