# Class Tools.AutoDoc.PikeObjects.PikeObject

Inheritance graph

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

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.

Constant objtype

  ``constant` `string` Tools.AutoDoc.PikeObjects.PikeObject.`objtype``

Description

  The object type identifier.

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`