Class YARD::Namespace

Object
  |
  +--YARD::Namespace

All Included Modules:
       Singleton

Attributes

namespace [R]

Constructor Summary

initialize

Public Class Method Summary

Object add_object(object)
Object all
Object at(name)
Object each_object
Object find_from_path(object, name)
CodeObject find_or_create_namespace(namespace)
      Attempt to find a namespace and return it if it exists .
Object load(file = "Yardoc", reload = false)
Object root
Object save

Public Instance Method Summary

Object add_object(object)
Object at(name)
Object namespace
      Returns the value of attribute namespace .
Object namespace=(value)
      Sets the attribute namespace .

Public Class Method Details

add_object

public Object add_object(object)

all

public Object all

at

public Object at(name)

each_object

public Object each_object

find_from_path

public Object find_from_path(object, name)

find_or_create_namespace

public CodeObject find_or_create_namespace(namespace)

Attempt to find a namespace and return it if it exists. Similar to the YARD::Namsepace::at method but creates the namespace as a module if it does not exist, and return it.

Parameters:
[String] namespace - the namespace to search for.
Returns:
the namespace that was found or created.

load

public Object load(file = "Yardoc", reload = false)

root

public Object root

save

public Object save

Public Instance Method Details

add_object

public Object add_object(object)

at

public Object at(name)

namespace

public Object namespace

Returns the value of attribute namespace

namespace=

public Object namespace=(value)

Sets the attribute namespace

Parameters:
value - the value to set the attribute namespace to.