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

#contentsString

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

#default_returnString 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

#dependenciesBoolean

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

#embed_mixinsArray<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.

#formatSymbol Originally defined in class Templates::TemplateOptions

Returns the template output format

Returns:

  • (Symbol)

    the template output format

#fullBoolean

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

#globalsOpenStruct 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_returnBoolean 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

#highlightBoolean Originally defined in class Templates::TemplateOptions

Returns whether code blocks should be syntax highlighted

Returns:

  • (Boolean)

    whether code blocks should be syntax highlighted

#indexBoolean Originally defined in class Templates::TemplateOptions

Returns whether the page is the “index”

Returns:

  • (Boolean)

    whether the page is the “index”

#markupSymbol 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_providerClass 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_highlightBoolean Originally defined in class Templates::TemplateOptions

Deprecated.

use #highlight instead.

Returns whether highlighting should be ignored

Returns:

  • (Boolean)

    whether highlighting should be ignored

#objectCodeObjects::Base Originally defined in class Templates::TemplateOptions

Returns the main object being generated in the template

Returns:

#ownerCodeObjects::Base Originally defined in class Templates::TemplateOptions

Returns the owner of the generated object

Returns:

#page_titleString Originally defined in class Templates::TemplateOptions

Returns the title of a given page

Returns:

  • (String)

    the title of a given page

#serializeBoolean Originally defined in class Templates::TemplateOptions

Returns whether serialization should be performed

Returns:

  • (Boolean)

    whether serialization should be performed

#serializerSerializers::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.

#templateSymbol Originally defined in class Templates::TemplateOptions

Returns the template name used to render output

Returns:

  • (Symbol)

    the template name used to render output

#typeSymbol Originally defined in class Templates::TemplateOptions

Returns the template type used to generate output

Returns:

  • (Symbol)

    the template type used to generate output

#verifierVerifier Originally defined in class Templates::TemplateOptions

Returns the verifier object

Returns:

Instance Method Details

#format:dot

Returns the default output format

Returns:

  • (:dot)

    the default output format



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

default_attr :format, :dot