HeaderDoc::Var

Declared In:

Var.pm

Introduction

API object that that describes a global variable, class instance variable, or package variable.

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

_initialize: Initializes an instance of a Var object.
clone: Duplicates this Var object into another one.
isProperty: Returns whether the variable described by this object is an Objective-C property.
printObject: Prints this object for debugging purposes.
setDeclaration: Sets the declaration.

Initializes an instance of a Var object.

sub _initialize

Duplicates this Var object into another one.

sub clone

Returns whether the variable described by this object is an Objective-C property.

sub isProperty

Returns 0 or 1.

Prints this object for debugging purposes.

sub printObject

Sets the declaration.

sub setDeclaration

HeaderDoc::Var::VERSION: The revision control revision number for this module.
ISPROPERTY: Value is 1 if this is an Objective-C property, else 1.
RESULT: The contents of the @result or @return(s) tags.

The revision control revision number for this module.

$HeaderDoc::Var::VERSION = '$Revision: 1298084579 $';

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

Value is 1 if this is an Objective-C property, else 1.

$self->{ISPROPERTY}

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

$self->{RESULT}

Last Updated: Saturday, August 06, 2016