| Extracted from Pike v7.8 release 866 at 2016-04-05.

[Top]
Tools
Tools.AutoDoc
Tools.AutoDoc.PikeObjects
Tools.AutoDoc.PikeObjects.PikeObject

# Class Tools.AutoDoc.PikeObjects.PikeObject

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 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 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.

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

Description

  Relocation information.

Variable squeezedInDoc

  `Documentation Tools.AutoDoc.PikeObjects.PikeObject.squeezedInDoc`