Class: GL::Registry::Token Abstract

Inherits:

Object

• Object
• GL::Registry::Token

Defined in:

lib/opengl/registry/token.rb

Overview

This class is abstract.

Base class for OpenGL registry defined items.

Direct Known Subclasses

Argument, Enum, Feature, FeatureProvider, Function, Group

Instance Attribute Summary

• #comment ⇒ String? readonly

  An arbitrary comment associated with this object.

Instance Method Summary

• #initialize(node) ⇒ Token constructor

  Creates a new instance of the Token class.

• #to_s ⇒ String

  The string representation of this object.

Constructor Details

#initialize(node) ⇒ Token

Creates a new instance of the GL::Registry::Token class.

Parameters:

• node (Ox::Element) —

  The XML element defining the instance.

Raises:

• (ArgumentError)

# File 'lib/opengl/registry/token.rb', line 16

def initialize(node)
  raise ArgumentError, 'item node cannot be nil' unless node

  @comment = node[Words::COMMENT]
end

Instance Attribute Details

#comment ⇒ String? (readonly)

Returns an arbitrary comment associated with this object.

Returns:

• (String?) —

  an arbitrary comment associated with this object.

# File 'lib/opengl/registry/token.rb', line 10

def comment
  @comment
end

Instance Method Details

#to_s ⇒ String

Returns the string representation of this object.

Returns:

• (String) —

  the string representation of this object.

# File 'lib/opengl/registry/token.rb', line 24

def to_s
  @name || super
end