Class: YARD::CLI::GraphOptions
- Inherits:
-
Templates::TemplateOptions
- Object
- Options
- Templates::TemplateOptions
- YARD::CLI::GraphOptions
- Defined in:
- lib/yard/cli/graph.rb
Overview
Options to pass to the Graph CLI.
Instance Attribute Summary collapse
-
#contents ⇒ String
Any contents to pass to the digraph.
-
#default_return ⇒ String
inherited
from Templates::TemplateOptions
The default return type for a method with no return tags.
-
#dependencies ⇒ Boolean
Whether to show the object dependencies.
-
#embed_mixins ⇒ Array<String>
inherited
from Templates::TemplateOptions
An array of module name wildcards to embed into class documentation as if their methods were defined directly in the class.
-
#format ⇒ Symbol
inherited
from Templates::TemplateOptions
The template output format.
-
#full ⇒ Boolean
Whether to list the full class diagram.
-
#globals ⇒ OpenStruct
(also: #__globals)
inherited
from Templates::TemplateOptions
An open struct containing any global state across all generated objects in a template.
-
#hide_void_return ⇒ Boolean
inherited
from Templates::TemplateOptions
Whether void methods should show “void” in their signature.
-
#highlight ⇒ Boolean
inherited
from Templates::TemplateOptions
Whether code blocks should be syntax highlighted.
-
#index ⇒ Boolean
inherited
from Templates::TemplateOptions
Whether the page is the “index”.
-
#markup ⇒ Symbol
inherited
from Templates::TemplateOptions
The markup format to use when parsing docstrings.
-
#markup_provider ⇒ Class
inherited
from Templates::TemplateOptions
The markup provider class for the markup format.
-
#no_highlight ⇒ Boolean
inherited
from Templates::TemplateOptions
deprecated
Deprecated.
use Templates::TemplateOptions#highlight instead.
-
#object ⇒ CodeObjects::Base
inherited
from Templates::TemplateOptions
The main object being generated in the template.
-
#owner ⇒ CodeObjects::Base
inherited
from Templates::TemplateOptions
The owner of the generated object.
-
#page_title ⇒ String
inherited
from Templates::TemplateOptions
The title of a given page.
-
#serialize ⇒ Boolean
inherited
from Templates::TemplateOptions
Whether serialization should be performed.
-
#serializer ⇒ Serializers::Base
inherited
from Templates::TemplateOptions
The serializer used to generate links and serialize output.
-
#template ⇒ Symbol
inherited
from Templates::TemplateOptions
The template name used to render output.
-
#type ⇒ Symbol
inherited
from Templates::TemplateOptions
The template type used to generate output.
-
#verifier ⇒ Verifier
inherited
from Templates::TemplateOptions
The verifier object.
Instance Method Summary collapse
-
#format ⇒ :dot
The default output format.
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class YARD::Options
Instance Attribute Details
#contents ⇒ String
Returns any contents to pass to the digraph
15 16 17 |
# File 'lib/yard/cli/graph.rb', line 15 def contents @contents end |
#default_return ⇒ String Originally defined in class Templates::TemplateOptions
Returns the default return type for a method with no return tags
#dependencies ⇒ Boolean
Returns whether to show the object dependencies
12 13 14 |
# File 'lib/yard/cli/graph.rb', line 12 def dependencies @dependencies end |
#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.
#format ⇒ Symbol Originally defined in class Templates::TemplateOptions
Returns the template output format
#full ⇒ Boolean
Returns whether to list the full class diagram
9 10 11 |
# File 'lib/yard/cli/graph.rb', line 9 def full @full 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.
#hide_void_return ⇒ Boolean Originally defined in class Templates::TemplateOptions
Returns 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
#index ⇒ Boolean Originally defined in class Templates::TemplateOptions
Returns whether the page is the “index”
#markup ⇒ Symbol Originally defined in class Templates::TemplateOptions
Returns 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
#no_highlight ⇒ Boolean Originally defined in class Templates::TemplateOptions
use #highlight instead.
Returns whether highlighting should be ignored
#object ⇒ CodeObjects::Base Originally defined in class Templates::TemplateOptions
Returns the main object being generated in the template
#owner ⇒ CodeObjects::Base Originally defined in class Templates::TemplateOptions
Returns the owner of the generated object
#page_title ⇒ String Originally defined in class Templates::TemplateOptions
Returns the title of a given page
#serialize ⇒ Boolean Originally defined in class Templates::TemplateOptions
Returns 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
.
#template ⇒ Symbol Originally defined in class Templates::TemplateOptions
Returns the template name used to render output
#type ⇒ Symbol Originally defined in class Templates::TemplateOptions
Returns the template type used to generate output
#verifier ⇒ Verifier Originally defined in class Templates::TemplateOptions
Returns the verifier object
Instance Method Details
#format ⇒ :dot
Returns the default output format
6 |
# File 'lib/yard/cli/graph.rb', line 6 default_attr :format, :dot |