Class: YARD::Server::Commands::LibraryOptions
- Inherits:
-
CLI::YardocOptions
- Object
- Options
- Templates::TemplateOptions
- CLI::YardocOptions
- YARD::Server::Commands::LibraryOptions
- Defined in:
- lib/yard/server/commands/library_command.rb
Overview
Instance Attribute Summary (collapse)
- - (Object) command
-
- (String) default_return
inherited
from Templates::TemplateOptions
The default return type for a method with no return tags.
-
- (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.
-
- (CodeObjects::ExtraFileObject) file
inherited
from CLI::YardocOptions
The file object being rendered.
-
- (Symbol) format
inherited
from Templates::TemplateOptions
The template output format.
- - (Object) frames
-
- (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.
-
- (Numeric) index
inherited
from CLI::YardocOptions
An index value for rendering sequentially related templates.
-
- (CodeObjects::Base) item
inherited
from CLI::YardocOptions
An extra item to send to a template that is not the main rendered object.
-
- (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.
-
- (Array<CodeObjects::Base>) objects
inherited
from CLI::YardocOptions
The list of code objects to render the templates with.
-
- (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.
-
- (CodeObjects::ExtraFileObject) readme
inherited
from CLI::YardocOptions
The README file object rendered along with objects.
-
- (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)
- - (Object) adapter
- - (Object) each {|:adapter, adapter| ... }
- - (Object) library
- - (Object) serialize
- - (Object) serializer
- - (Object) single_library
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class YARD::Options
Instance Attribute Details
- (Object) command
13 14 15 |
# File 'lib/yard/server/commands/library_command.rb', line 13 def command @command end |
- (String) default_return Originally defined in class Templates::TemplateOptions
Returns the default return type for a method with no return tags
- (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.
- (CodeObjects::ExtraFileObject) file 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).
- (Symbol) format Originally defined in class Templates::TemplateOptions
Returns the template output format
- (Object) frames
14 15 16 |
# File 'lib/yard/server/commands/library_command.rb', line 14 def frames @frames 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
- (Numeric) index Originally defined in class CLI::YardocOptions
Returns An index value for rendering sequentially related templates
- (CodeObjects::Base) item Originally defined in class CLI::YardocOptions
Returns an extra item to send to a template that is not the main rendered object
- (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
- (Array<CodeObjects::Base>) objects Originally defined in class CLI::YardocOptions
Returns the list of code objects to render the templates with.
- (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
- (CodeObjects::ExtraFileObject) readme Originally defined in class CLI::YardocOptions
Returns the README file object rendered along with objects
- (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
- (Object) adapter
7 |
# File 'lib/yard/server/commands/library_command.rb', line 7 def adapter; @command.adapter end |
- (Object) each {|:adapter, adapter| ... }
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 |
- (Object) library
8 |
# File 'lib/yard/server/commands/library_command.rb', line 8 def library; @command.library end |
- (Object) serialize
11 |
# File 'lib/yard/server/commands/library_command.rb', line 11 def serialize; false end |
- (Object) serializer
10 |
# File 'lib/yard/server/commands/library_command.rb', line 10 def serializer; @command.serializer end |
- (Object) single_library
9 |
# File 'lib/yard/server/commands/library_command.rb', line 9 def single_library; @command.single_library end |