123456789_123456789_123456789_123456789_123456789_

Class: YARD::CodeObjects::ConstantObject

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Base
Instance Chain:
self, Base
Inherits: YARD::CodeObjects::Base
Defined in: lib/yard/code_objects/constant_object.rb

Overview

A ConstantObject represents a Ruby constant (not a module or class). To access the constant's (source code) value, use #value.

Class Method Summary

Base - Inherited

.===

Compares the class with subclasses.
.new

Allocates a new code object.

Instance Attribute Summary

Base - Inherited

#base_docstring

The non-localized documentation string associated with the object.
#dynamic

Marks whether or not the method is conditionally defined at runtime.
#dynamic?

Is the object defined conditionally at runtime?
#files

The files the object was defined in.
#group,
#namespace

The namespace the object is defined in.
#namespace=

Sets the namespace the object is defined in.
#parent

Alias for Base#namespace.
#root?,
#signature

The one line signature representing an object.
#source

The source code associated with the object.
#source=

Attaches source code to a code object with an optional file location.
#source_type

Language of the source code associated with the object.
#visibility, #visibility=

Instance Method Summary

Base - Inherited

#==

Alias for Base#equal?.
#[]

Accesses a custom attribute on the object.
#[]=

Sets a custom attribute on the object.
#add_file

Associates a file with a code object, optionally adding the line where it was defined.
#add_tag

Add tags to the #docstring
#copy_to

Copies all data in this object to another code object, except for uniquely identifying information (path, namespace, name, scope).
#docstring

The documentation string associated with the object.
#docstring=

Attaches a docstring to a code object by parsing the comments attached to the statement and filling the #tags and #docstring methods with the parsed information.
#eql?

Alias for Base#equal?.
#equal?

Tests if another object is equal to this, including a proxy.
#file

Returns the filename the object was first parsed at, taking definitions with docstrings first.
#format

Renders the object using the templating system.
#has_tag?

Tests if the #docstring has a tag.
#hash,
#initialize

Creates a new code object.
#inspect

Inspects the object, returning the type and path.
#line

Returns the line the object was first parsed at (or nil).
#method_missing,
#name

The name of the object.
#path

Represents the unique path of the object.
#relative_path,
#sep

Override this method with a custom component separator.
#tag

Gets a tag from the #docstring
#tags

Gets a list of tags from the #docstring
#title, #to_ary,
#to_s

Alias for Base#path.
#type

Default type is the lowercase class name without the "Object" suffix.
#format_source

Formats source code by removing leading indentation.
#translate_docstring

Constructor Details

This class inherits a constructor from YARD::CodeObjects::Base

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class YARD::CodeObjects::Base

Instance Attribute Details

#value ⇒ String (rw)

The source code representing the constant's value

Returns:

  • (String) —

    the value the constant is set to

[ GitHub ] 

  


# File 'lib/yard/code_objects/constant_object.rb', line 10



attr_reader :value


  








  

    #value=(value)   (rw)
  

  [ GitHub ]


  

  


# File 'lib/yard/code_objects/constant_object.rb', line 12



def value=(value)
  @value = format_source(value)
end