Holds all the registered meta tags. If you want to extend YARD and add a new meta tag, you can do it in one of two ways.
Use {Library.define_tag} to define a new tag by passing the tag name and the factory method to use when creating the tag. These definitions will be auto expanded into ruby code similar to what is shown in method #2. If you do not provide a factory method to use, it will default to {DefaultFactory#parse_tag} Example:
define_tag "Parameter", :param, :with_types_and_name define_tag "Author", :author
The first line will expand to the code:
def param_tag(text) tag_factory.parse_tag_with_types_and_name(text) end
The second line will expand to:
def author_tag(text) tag_factory.parse_tag(text) end
Note that tag_factory is the factory object used to parse tags. This value defaults to the {DefaultFactory} class and can be set by changing {Library.default_factory}.
Write your own tagname_tag method that takes the raw text as a parameter. Example:
def mytag_tag(text) # parse your tag contents here end
This will allow you to use @mytag TEXT to add meta data to classes through the docstring. You can use the {Library#factory} object to help parse standard tag syntax.
If you have specialized tag parsing needs you can substitute the {factory} object with your own by setting {Library.default_factory= Library.default_factory} to a new class with its own parsing methods before running YARD. This is useful if you want to change the syntax of existing tags (@see, @since, etc.)
@see DefaultFactory @see Library.define_tag
# File lib/yard/tags/library.rb, line 51 def default_factory @default_factory ||= DefaultFactory.new end
Replace the factory object responsible for parsing tags by setting this to an object (or class) that responds to parse_TAGNAME methods where TAGNAME is the name of the tag.
You should set this value before performing any source parsing with YARD, otherwise your factory class will not be used.
@example
YARD::Tags::Library.default_factory = MyFactory
@param [Class, Object] factory the factory that parses all tags
@see DefaultFactory
# File lib/yard/tags/library.rb, line 68 def default_factory=(factory) @default_factory = factory.is_a?(Class) ? factory.new : factory end
Convenience method to define a new tag using one of {Tag}'s factory methods, or the regular {DefaultFactory#parse_tag} factory method if none is supplied.
@param [to_s] tag the tag name to create @param [to_s, Class<Tag>] meth the {Tag} factory method to call when
creating the tag or the name of the class to directly create a tag for
# File lib/yard/tags/library.rb, line 119 def define_tag(label, tag, meth = nil) if meth.is_a?(Class) && Tag > meth class_eval def #{tag}_tag(text) #{meth}.new(#{tag.inspect}, text) end, __FILE__, __LINE__ else class_eval def #{tag}_tag(text) send_to_factory(#{tag.inspect}, #{meth.inspect}, text) end, __FILE__, __LINE__ end @labels ||= SymbolHash.new(false) @labels.update(tag => label) @factory_methods ||= SymbolHash.new(false) @factory_methods.update(tag => meth) tag end
Returns the factory method used to parse the tag text for a specific tag
@param [Symbol] tag the tag name @return [Symbol] the factory method name for the tag @return [Class<Tag>] the Tag class to use to parse the tag @return [nil] if the tag is freeform text @since 0.6.0
# File lib/yard/tags/library.rb, line 79 def factory_method_for(tag) @factory_methods[tag] end
# File lib/yard/tags/library.rb, line 47 def instance @instance ||= new end
# File lib/yard/tags/library.rb, line 160 def initialize(factory = Library.default_factory) self.factory = factory end
Sorts the labels lexically by their label name, often used when displaying the tags.
@return [Array<Symbol>, String] the sorted labels as an array of the tag name and label
# File lib/yard/tags/library.rb, line 109 def sorted_labels labels.sort_by {|a| a.last.downcase } end
Generated with the Darkfish Rdoc Generator 2.