Class: YARD::CLI::GraphOptions

Inherits:
Templates::TemplateOptions show all
Defined in:
lib/yard/cli/graph.rb

Overview

Options to pass to the Graph CLI.

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

- (String) contents

Returns any contents to pass to the digraph

Returns:

  • (String)

    any contents to pass to the digraph



15
16
17
# File 'lib/yard/cli/graph.rb', line 15

def contents
  @contents
end

- (String) default_return 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

- (Boolean) dependencies

Returns whether to show the object dependencies

Returns:

  • (Boolean)

    whether to show the object dependencies



12
13
14
# File 'lib/yard/cli/graph.rb', line 12

def dependencies
  @dependencies
end

- (Array<String>) embed_mixins 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.

- (Symbol) format Originally defined in class Templates::TemplateOptions

Returns the template output format

Returns:

  • (Symbol)

    the template output format

- (Boolean) full

Returns whether to list the full class diagram

Returns:

  • (Boolean)

    whether to list the full class diagram



9
10
11
# File 'lib/yard/cli/graph.rb', line 9

def full
  @full
end

- (OpenStruct) globals 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.

- (Boolean) hide_void_return 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

- (Boolean) highlight Originally defined in class Templates::TemplateOptions

Returns whether code blocks should be syntax highlighted

Returns:

  • (Boolean)

    whether code blocks should be syntax highlighted

- (Symbol) markup 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

- (Class) markup_provider 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

- (Boolean) no_highlight Originally defined in class Templates::TemplateOptions

Deprecated.

use #highlight instead.

Returns whether highlighting should be ignored

Returns:

  • (Boolean)

    whether highlighting should be ignored

- (CodeObjects::Base) object Originally defined in class Templates::TemplateOptions

Returns the main object being generated in the template

Returns:

- (CodeObjects::Base) owner Originally defined in class Templates::TemplateOptions

Returns the owner of the generated object

Returns:

- (String) page_title Originally defined in class Templates::TemplateOptions

Returns the title of a given page

Returns:

  • (String)

    the title of a given page

- (Boolean) serialize Originally defined in class Templates::TemplateOptions

Returns whether serialization should be performed

Returns:

  • (Boolean)

    whether serialization should be performed

- (Serializers::Base) serializer 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.

- (Symbol) template Originally defined in class Templates::TemplateOptions

Returns the template name used to render output

Returns:

  • (Symbol)

    the template name used to render output

- (Symbol) type 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

- (:dot) format

Returns the default output format

Returns:

  • (:dot)

    the default output format



6
# File 'lib/yard/cli/graph.rb', line 6

default_attr :format, :dot