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

Inherits:
DisplayObjectCommand show all
Defined in:
lib/yard/server/commands/frames_command.rb

Overview

Displays an object wrapped in frames

Since:

Basic Command and Adapter Options (collapse)

Attributes Set Per Request (collapse)

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods included from DocServerHelper

#base_path, #router, #url_for, #url_for_file, #url_for_frameset, #url_for_index, #url_for_list, #url_for_main

Constructor Details

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

Instance Attribute Details

- (Adapter) adapter Originally defined in class Base

Returns the server adapter

Returns:

Since:

  • 0.6.0

- (String) body Originally defined in class Base

Returns the response body. Defaults to empty string.

Returns:

  • (String)

    the response body. Defaults to empty string.

Since:

  • 0.6.0

- (Boolean) caching Originally defined in class Base

Returns whether to cache

Returns:

  • (Boolean)

    whether to cache

Since:

  • 0.6.0

- (Hash) command_options Originally defined in class Base

Returns the options passed to the command’s constructor

Returns:

  • (Hash)

    the options passed to the command’s constructor

Since:

  • 0.6.0

- (Hash{String => String}) headers Originally defined in class Base

Returns response headers

Returns:

Since:

  • 0.6.0

- (Boolean) incremental Originally defined in class LibraryCommand

Returns whether to reparse data

Returns:

  • (Boolean)

    whether to reparse data

Since:

  • 0.6.0

- (LibraryVersion) library Originally defined in class LibraryCommand

Returns the object containing library information

Returns:

Since:

  • 0.6.0

- (LibraryOptions) options Originally defined in class LibraryCommand

Returns default options for the library

Returns:

Since:

  • 0.6.0

- (String) path Originally defined in class Base

Returns the path after the command base URI

Returns:

  • (String)

    the path after the command base URI

Since:

  • 0.6.0

- (Request) request Originally defined in class Base

Returns request object

Returns:

  • (Request)

    request object

Since:

  • 0.6.0

- (Serializers::Base) serializer Originally defined in class LibraryCommand

Returns the serializer used to perform file linking

Returns:

Since:

  • 0.6.0

- (Boolean) single_library Originally defined in class LibraryCommand

Returns whether router should route for multiple libraries

Returns:

  • (Boolean)

    whether router should route for multiple libraries

Since:

  • 0.6.0

- (Numeric) status Originally defined in class Base

Returns status code. Defaults to 200 per request

Returns:

  • (Numeric)

    status code. Defaults to 200 per request

Since:

  • 0.6.0

Instance Method Details

- (Object) run

Since:

  • 0.6.0



6
7
8
9
10
11
# File 'lib/yard/server/commands/frames_command.rb', line 6

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