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)
-
- (String) contents
Any contents to pass to the digraph.
-
- (String) default_return
inherited
from Templates::TemplateOptions
The default return type for a method with no return tags.
-
- (Boolean) dependencies
Whether to show the object dependencies.
-
- (Array<String>) embed_mixins
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.
-
- (Symbol) format
inherited
from Templates::TemplateOptions
The template output format.
-
- (Boolean) full
Whether to list the full class diagram.
-
- (OpenStruct) globals
(also: #__globals)
inherited
from Templates::TemplateOptions
An open struct containing any global state across all generated objects in a template.
-
- (Boolean) hide_void_return
inherited
from Templates::TemplateOptions
Whether void methods should show "void" in their signature.
-
- (Boolean) highlight
inherited
from Templates::TemplateOptions
Whether code blocks should be syntax highlighted.
-
- (Symbol) markup
inherited
from Templates::TemplateOptions
The markup format to use when parsing docstrings.
-
- (Class) markup_provider
inherited
from Templates::TemplateOptions
The markup provider class for the markup format.
-
- (Boolean) no_highlight
inherited
from Templates::TemplateOptions
deprecated
Deprecated.
use Templates::TemplateOptions#highlight instead.
-
- (CodeObjects::Base) object
inherited
from Templates::TemplateOptions
The main object being generated in the template.
-
- (CodeObjects::Base) owner
inherited
from Templates::TemplateOptions
The owner of the generated object.
-
- (String) page_title
inherited
from Templates::TemplateOptions
The title of a given page.
-
- (Boolean) serialize
inherited
from Templates::TemplateOptions
Whether serialization should be performed.
-
- (Serializers::Base) serializer
inherited
from Templates::TemplateOptions
The serializer used to generate links and serialize output.
-
- (Symbol) template
inherited
from Templates::TemplateOptions
The template name used to render output.
-
- (Symbol) type
inherited
from Templates::TemplateOptions
The template type used to generate output.
-
- (Verifier) verifier
inherited
from Templates::TemplateOptions
The verifier object.
Instance Method Summary (collapse)
-
- (:dot) format
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
- (String) contents
Returns 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
- (Boolean) dependencies
Returns 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.
- (Symbol) format Originally defined in class Templates::TemplateOptions
Returns the template output format
- (Boolean) full
Returns 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.
- (Boolean) hide_void_return Originally defined in class Templates::TemplateOptions
Returns 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
- (Symbol) markup Originally defined in class Templates::TemplateOptions
Returns 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
- (Boolean) no_highlight Originally defined in class Templates::TemplateOptions
use #highlight instead.
Returns whether highlighting should be ignored
- (CodeObjects::Base) object Originally defined in class Templates::TemplateOptions
Returns the main object being generated in the template
- (CodeObjects::Base) owner Originally defined in class Templates::TemplateOptions
Returns the owner of the generated object
- (String) page_title Originally defined in class Templates::TemplateOptions
Returns the title of a given page
- (Boolean) serialize Originally defined in class Templates::TemplateOptions
Returns 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.
- (Symbol) template Originally defined in class Templates::TemplateOptions
Returns the template name used to render output
- (Symbol) type 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
- (:dot) format
Returns the default output format
6 |
# File 'lib/yard/cli/graph.rb', line 6 default_attr :format, :dot |