Class Tools.AutoDoc.PikeObjects.PikeObject

Inheritance graph
Tools.AutoDoc.PikeObjects.PikeObject Tools.AutoDoc.PikeObjects.Constant Tools.AutoDoc.PikeObjects.CppDirective Tools.AutoDoc.PikeObjects.Enum Tools.AutoDoc.PikeObjects.Inherit Tools.AutoDoc.PikeObjects.Method Tools.AutoDoc.PikeObjects.Typedef Tools.AutoDoc.PikeObjects.Variable Tools.AutoDoc.PikeObjects._Class_or_Module
Description

Base class for representing a documentable Pike lexical entity.

This class is inherited by classes for representing classes, functions, variables, etc.

See also

Inherit, Import, Class, Module, NameSpace, AutoDoc, Modifier, Method, Constant, Typedef, EnumConstant, Enum, Variable

Constant objtype

constant string Tools.AutoDoc.PikeObjects.PikeObject.objtype

Description

The object type identifier.

Variable appears
Variable belongs

string Tools.AutoDoc.PikeObjects.PikeObject.appears
string Tools.AutoDoc.PikeObjects.PikeObject.belongs

Description

Relocation information.

Variable modifiers

array(string) Tools.AutoDoc.PikeObjects.PikeObject.modifiers

Description

The set of modifiers affecting this entity.

Variable name

string Tools.AutoDoc.PikeObjects.PikeObject.name

Description

The name of the entity.

Variable position

SourcePosition Tools.AutoDoc.PikeObjects.PikeObject.position

Description

The source position where the entity was found.

Variable squeezedInDoc

Documentation Tools.AutoDoc.PikeObjects.PikeObject.squeezedInDoc