Overview

Namespaces

  • None
  • Peg
    • Cli
      • Commands
    • Config
    • Custom
      • Command
        • Action
          • Generate
          • Parse
      • CommandLine
      • Config
      • Localization
      • Utilities
    • Lib
      • Definitions
        • Element
      • Generator
      • Lexers
      • Plugins
      • Signals
        • Data
          • Definitions
          • Lexers
        • Type
  • PHP

Classes

  • ClassElement
  • ClassVariable
  • Constant
  • Enumeration
  • FunctionElement
  • GlobalVariable
  • Header
  • NamespaceElement
  • Overload
  • Parameter
  • ReturnType
  • TypeComponents
  • TypeDef
  • VariableType
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class GlobalVariable

Represents a global variable element declared on a header file.

Peg\Lib\Definitions\Element\VariableType
Extended by Peg\Lib\Definitions\Element\GlobalVariable
Namespace: Peg\Lib\Definitions\Element
Located at src/Definitions/Element/GlobalVariable.php
Methods summary
public
# __construct( string $name, string $type, string $description = "" )

Create a global variable element using a declaration specification for its type.

Create a global variable element using a declaration specification for its type.

Parameters

$name
string
$name Name of the variable.
$type
string
$type Parameter type by specification, eg: const int*
$description
string
$description A description used to generate documentation.

Overrides

Peg\Lib\Definitions\Element\VariableType::__construct()
Methods inherited from Peg\Lib\Definitions\Element\VariableType
GetDeclarationCode()
Properties summary
public string $name
#

Holds the name of the element

Holds the name of the element

public Peg\Lib\Definitions\Element\Header $header
#

Reference to the header containing this element.

Reference to the header containing this element.

public Peg\Lib\Definitions\Element\NamespaceElement $namespace
#

Reference to the namespace containing this element.

Reference to the namespace containing this element.

Properties inherited from Peg\Lib\Definitions\Element\VariableType
$description, $indirection_level, $is_array, $is_const, $is_pointer, $is_reference, $is_unsigned, $original_type, $type
PEG Api API documentation generated by ApiGen 2.8.0