Class: YARD::Server::Commands::LibraryOptions

Inherits:
CLI::YardocOptions show all
Defined in:
lib/yard/server/commands/library_command.rb

Overview

Since:

  • 0.6.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class YARD::Options

Instance Attribute Details

#command ⇒ Object

Since:

  • 0.6.0



13
14
15
 
# File 'lib/yard/server/commands/library_command.rb', line 13

def command
  @command
end

#default_return ⇒ String Originally defined in class Templates::TemplateOptions

Returns the default return type for a method with no return tags

Returns:

  • (String) —

    the default return type for a method with no return tags

#embed_mixins ⇒ Array<String> Originally defined in class Templates::TemplateOptions

Returns an array of module name wildcards to embed into class documentation as if their methods were defined directly in the class. Useful for modules like ClassMethods. If the name contains '::', the module is matched against the full mixin path, otherwise only the module name is used.

Examples:

A list of mixin path names (including wildcards)

opts.embed_mixins #=> ['ClassMethods', '*Helper', 'YARD::*']

Returns:

  • (Array<String>) —

    an array of module name wildcards to embed into class documentation as if their methods were defined directly in the class. Useful for modules like ClassMethods. If the name contains '::', the module is matched against the full mixin path, otherwise only the module name is used.

#file ⇒ CodeObjects::ExtraFileObject Originally defined in class CLI::YardocOptions

Returns the file object being rendered. The object key is not used so that a file may be rendered in the context of an object's namespace (for generating links).

Returns:

  • (CodeObjects::ExtraFileObject) —

    the file object being rendered. The object key is not used so that a file may be rendered in the context of an object's namespace (for generating links).

#format ⇒ Symbol Originally defined in class Templates::TemplateOptions

Returns the template output format

Returns:

  • (Symbol) —

    the template output format

#frames ⇒ Object

Since:

  • 0.6.0



14
15
16
 
# File 'lib/yard/server/commands/library_command.rb', line 14

def frames
  @frames
end

#globals ⇒ OpenStruct Also known as: __globals Originally defined in class Templates::TemplateOptions

Returns an open struct containing any global state across all generated objects in a template.

Returns:

  • (OpenStruct) —

    an open struct containing any global state across all generated objects in a template.

#hide_void_return ⇒ Boolean Originally defined in class Templates::TemplateOptions

Returns whether void methods should show “void” in their signature

Returns:

  • (Boolean) —

    whether void methods should show “void” in their signature

#highlight ⇒ Boolean Originally defined in class Templates::TemplateOptions

Returns whether code blocks should be syntax highlighted

Returns:

  • (Boolean) —

    whether code blocks should be syntax highlighted

#index ⇒ Numeric Originally defined in class CLI::YardocOptions

Returns An index value for rendering sequentially related templates

Returns:

  • (Numeric) —

    An index value for rendering sequentially related templates

#index ⇒ Boolean Originally defined in class Templates::TemplateOptions

Returns whether the page is the “index”

Returns:

  • (Boolean) —

    whether the page is the “index”

#item ⇒ CodeObjects::Base Originally defined in class CLI::YardocOptions

Returns an extra item to send to a template that is not the main rendered object

Returns:

  • (CodeObjects::Base) —

    an extra item to send to a template that is not the main rendered object

#locale ⇒ String Originally defined in class CLI::YardocOptions

Returns the current locale

Returns:

  • (String) —

    the current locale

#markup ⇒ Symbol Originally defined in class Templates::TemplateOptions

Returns the markup format to use when parsing docstrings

Returns:

  • (Symbol) —

    the markup format to use when parsing docstrings

#markup_provider ⇒ Class Originally defined in class Templates::TemplateOptions

Returns the markup provider class for the markup format

Returns:

  • (Class) —

    the markup provider class for the markup format

#no_highlight ⇒ Boolean Originally defined in class Templates::TemplateOptions

Deprecated.

use #highlight instead.

Returns whether highlighting should be ignored

Returns:

  • (Boolean) —

    whether highlighting should be ignored

#object ⇒ CodeObjects::Base Originally defined in class Templates::TemplateOptions

Returns the main object being generated in the template

Returns:

#objects ⇒ Array<CodeObjects::Base> Originally defined in class CLI::YardocOptions

Returns the list of code objects to render the templates with.

Returns:

#owner ⇒ CodeObjects::Base Originally defined in class Templates::TemplateOptions

Returns the owner of the generated object

Returns:

#page_title ⇒ String Originally defined in class Templates::TemplateOptions

Returns the title of a given page

Returns:

  • (String) —

    the title of a given page

#readme ⇒ CodeObjects::ExtraFileObject Originally defined in class CLI::YardocOptions

Returns the README file object rendered along with objects

Returns:

#serialize ⇒ Boolean Originally defined in class Templates::TemplateOptions

Returns whether serialization should be performed

Returns:

  • (Boolean) —

    whether serialization should be performed

#serializer ⇒ Serializers::Base Originally defined in class Templates::TemplateOptions

Returns the serializer used to generate links and serialize output. Serialization output only occurs if #serialize is true.

Returns:

  • (Serializers::Base) —

    the serializer used to generate links and serialize output. Serialization output only occurs if #serialize is true.

#template ⇒ Symbol Originally defined in class Templates::TemplateOptions

Returns the template name used to render output

Returns:

  • (Symbol) —

    the template name used to render output

#type ⇒ Symbol Originally defined in class Templates::TemplateOptions

Returns the template type used to generate output

Returns:

  • (Symbol) —

    the template type used to generate output

#verifier ⇒ Verifier Originally defined in class Templates::TemplateOptions

Returns the verifier object

Returns:

Instance Method Details

#adapter ⇒ Object

Since:

  • 0.6.0



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

def adapter; @command.adapter end

#each {|:adapter, adapter| ... } ⇒ Object

Yields:

  • (:adapter, adapter)

Since:

  • 0.6.0



16
17
18
19
20
21
22
 
# File 'lib/yard/server/commands/library_command.rb', line 16

def each(&block)
  super(&block)
  yield(:adapter, adapter)
  yield(:library, library)
  yield(:single_library, single_library)
  yield(:serializer, serializer)
end

#library ⇒ Object

Since:

  • 0.6.0



8
 
# File 'lib/yard/server/commands/library_command.rb', line 8

def library; @command.library end

#serialize ⇒ Object

Since:

  • 0.6.0



11
 
# File 'lib/yard/server/commands/library_command.rb', line 11

def serialize; false end

#serializer ⇒ Object

Since:

  • 0.6.0



10
 
# File 'lib/yard/server/commands/library_command.rb', line 10

def serializer; @command.serializer end

#single_library ⇒ Object

Since:

  • 0.6.0



9
 
# File 'lib/yard/server/commands/library_command.rb', line 9

def single_library; @command.single_library end