Class: YARD::CodeObjects::ConstantObject
- 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.
Instance Attribute Summary collapse
-
#base_docstring ⇒ Docstring
inherited
from Base
readonly
The non-localized documentation string associated with the object.
-
#dynamic ⇒ Boolean
inherited
from Base
Marks whether or not the method is conditionally defined at runtime.
-
#files ⇒ Array<String>
inherited
from Base
readonly
The files the object was defined in.
-
#group ⇒ String
inherited
from Base
The group this object is associated with.
-
#namespace ⇒ NamespaceObject
(also: #parent)
inherited
from Base
The namespace the object is defined in.
-
#signature ⇒ String
inherited
from Base
The one line signature representing an object.
-
#source ⇒ String?
inherited
from Base
The source code associated with the object.
-
#source_type ⇒ Symbol
inherited
from Base
Language of the source code associated with the object.
-
#value ⇒ String
The source code representing the constant's value.
-
#visibility ⇒ Symbol
inherited
from Base
The visibility of an object (:public, :private, :protected).
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
#base_docstring ⇒ Docstring (readonly) Originally defined in class Base
The non-localized documentation string associated with the object
#dynamic ⇒ Boolean Originally defined in class Base
Marks whether or not the method is conditionally defined at runtime
#files ⇒ Array<String> (readonly) Originally defined in class Base
The files the object was defined in. To add a file, use #add_file.
#namespace ⇒ NamespaceObject Also known as: parent Originally defined in class Base
The namespace the object is defined in. If the object is in the top level namespace, this is Registry.root
#signature ⇒ String Originally defined in class Base
The one line signature representing an object. For a method, this will be of the form “def meth(arguments…)”. This is usually the first source line.
#source_type ⇒ Symbol Originally defined in class Base
Language of the source code associated with the object. Defaults to
:ruby
.
#value ⇒ String
The source code representing the constant's value
7 8 9 |
# File 'lib/yard/code_objects/constant_object.rb', line 7 def value @value end |
#visibility ⇒ Symbol Originally defined in class Base
Returns the visibility of an object (:public, :private, :protected)