123456789_123456789_123456789_123456789_123456789_

Class: YARD::Server::Commands::FramesCommand

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, DisplayObjectCommand, LibraryCommand, Base
Instance Chain:
self, DisplayObjectCommand, ::YARD::Server::DocServerHelper, LibraryCommand, Base
Inherits: YARD::Server::Commands::DisplayObjectCommand
Defined in: lib/yard/server/commands/frames_command.rb

Overview

Displays an object wrapped in frames

Since:

  • 0.6.0

Class Method Summary

LibraryCommand - Inherited

.new

Base - Inherited

.new

Creates a new command object, setting attributes named by keys in the options hash.

Instance Attribute Summary

LibraryCommand - Inherited

#incremental, #library, #options, #serializer, #single_library, #use_fork, #can_fork?

Base - Inherited

#adapter, #body, #caching, #command_options, #headers, #path, #request, #status

Instance Method Summary

DisplayObjectCommand - Inherited

#index, #not_found, #run, #object_path

::YARD::Server::DocServerHelper - Included

#abs_url, #base_path, #mtime, #mtime_url, #router,
#url_for

Modifies Templates::Helpers::HtmlHelper#url_for to return a URL instead of a disk location.
#url_for_file

Modifies Templates::Helpers::HtmlHelper#url_for_file to return a URL instead of a disk location.
#url_for_frameset

Returns the frames URL for the page.
#url_for_index

Returns the URL for the alphabetic index page.
#url_for_list

Modifies Templates::Helpers::HtmlHelper#url_for_list to return a URL based on the list prefix instead of a HTML filename.
#url_for_main

Returns the main URL, first checking a readme and then linking to the index.

LibraryCommand - Inherited

#call, #call_with_fork, #call_without_fork,
#fulldoc_template

Hack to load a custom fulldoc template object that does not do any rendering/generation.
#load_yardoc, #not_prepared, #restore_template_info, #save_default_template_info, #setup_library, #setup_yardopts

Base - Inherited

#call

The main method called by a router with a request object.
#run

Subclass this method to implement a custom command.
#add_cache_control

Add a conservative cache control policy to reduce load on requests served with "?1234567890" style timestamp query strings.

Constructor Details

This class inherits a constructor from YARD::Server::Commands::LibraryCommand

Instance Method Details

#run

Since:

  • 0.6.0

[ GitHub ] 

  


# File 'lib/yard/server/commands/frames_command.rb', line 7



def run
  options.update(:frames => true, :type => :fulldoc)
  tpl = fulldoc_template
  tpl.generate_frameset
  cache(tpl.contents)
end