Module: YARD::Templates::Template

Extended by:
ClassMethods
Includes:
ErbCache, Helpers::BaseHelper, Helpers::MethodHelper
Defined in:
lib/yard/templates/template.rb

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary (collapse)

Attributes included from Helpers::BaseHelper

#object, #owner, #serializer

Class Method Summary (collapse)

Methods included from Helpers::MethodHelper

#format_args, #format_block, #format_code, #format_constant, #format_lines, #format_return_types

Methods included from Helpers::BaseHelper

#format_object_title, #format_object_type, #format_source, #format_types, #globals, #h, #link_file, #link_include_file, #link_include_object, #link_object, #link_url, #linkify, #run_verifier

Methods included from ErbCache

clear!, method_for

Instance Attribute Details

- (Object) full_path Originally defined in module ClassMethods

Returns the value of attribute full_path

- (Object) path Originally defined in module ClassMethods

Returns the value of attribute path

Class Method Details

+ (String) find_file(basename) Originally defined in module ClassMethods

Searches for a file identified by basename in the template's path as well as any mixed in template paths. Equivalent to calling #find_nth_file with index of 1.

Parameters:

  • basename (String)

    the filename to search for

Returns:

  • (String)

    the full path of a file on disk with filename basename in one of the template's paths.

See Also:

  • find_nth_file

+ (String) find_nth_file(basename, index = 1) Originally defined in module ClassMethods

Searches for the nth file (where n = index) identified by basename in the template's path and any mixed in template paths.

Parameters:

  • basename (String)

    the filename to search for

  • index (Fixnum) (defaults to: 1)

    the nth existing file to return

Returns:

  • (String)

    the full path of the nth file on disk with filename basename in one of the template paths

+ (Object) full_paths Originally defined in module ClassMethods

+ (ClassMethods) initialize(path, full_paths) Originally defined in module ClassMethods

A new instance of ClassMethods

Returns:

+ (Boolean) is_a?(klass) Originally defined in module ClassMethods

Returns:

  • (Boolean)

+ (Object) new(*args) Originally defined in module ClassMethods

Creates a new template object to be rendered with YARD::Templates::Template#run

+ (Object) run(*args) Originally defined in module ClassMethods

+ (Object) S(*args) Originally defined in module ClassMethods

Alias for creating a Section with arguments

See Also:

Since:

  • 0.6.0

+ (Object) T(*path) Originally defined in module ClassMethods