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