Alias for creating a {Section} with arguments @see Section#initialize @since 0.6.0
# File lib/yard/templates/template.rb, line 145 def S(*args) Section.new(*args) end
# File lib/yard/templates/template.rb, line 138 def T(*path) Engine.template(*path) end
Searches for a file identified by basename in the template's path as well as any mixed in template paths. Equivalent to calling {ClassMethods#find_nth_file} with index of 1.
@param [String] basename the filename to search for @return [String] the full path of a file on disk with filename
+basename+ in one of the template's paths.
@see find_nth_file
# File lib/yard/templates/template.rb, line 97 def find_file(basename) find_nth_file(basename) end
Searches for the nth file (where n = index) identified by basename in the template's path and any mixed in template paths.
@param [String] basename the filename to search for @param [Fixnum] index the nth existing file to return @return [String] the full path of the nth file on disk with
filename +basename+ in one of the template paths
# File lib/yard/templates/template.rb, line 108 def find_nth_file(basename, index = 1) n = 1 full_paths.each do |path| file = File.join(path, basename) if File.file?(file) return file if index == n n += 1 end end nil end
@return [Array<String>] a list of full paths @note This method caches path results. Paths should not be modified
after this method is called; call {#reset_full_paths} to reset cache.
# File lib/yard/templates/template.rb, line 64 def full_paths reset_full_paths unless defined? @cached_included_modules return @full_paths if included_modules == @cached_included_modules @cached_included_modules = included_modules @full_paths = included_modules.inject([full_path]) do |paths, mod| paths |= mod.full_paths if mod.respond_to?(:full_paths) paths end end
# File lib/yard/templates/template.rb, line 121 def is_a?(klass) return true if klass == Template super(klass) end
Creates a new template object to be rendered with {Template#run}
# File lib/yard/templates/template.rb, line 127 def new(*args) obj = Object.new.extend(self) obj.class = self obj.send(:initialize, *args) obj end
Resets cache for {full_paths}
# File lib/yard/templates/template.rb, line 76 def reset_full_paths @cached_included_modules = nil end
Generated with the Darkfish Rdoc Generator 2.