class YardDocExample::MyClass

An old implementation, is replaced by {YardDocExample::MyOtherClass}

@author Jane Doe @abstract @since 0.6.0 @deprecated Use {MyOtherClass} instead

@attr [String] attribute_name a full description of the attribute @attr_reader [Hash] name_readonly description of a readonly attribute @attr_writer [Array<String>] name_writeonly description of writeonly attribute @!attribute [r] count

@return [Number] the number of items

@see rubydoc.info/gems/yard/file/docs/GettingStarted.md Getting Started guide with YARD @see www.rubydoc.info/gems/yard/file/docs/Tags.md YARD Tags @see gist.github.com/chetan/1827484 YARD cheat sheet

Public Instance Methods

do_something(arr, arr2, opts:) click to toggle source

@see example.com Description of URL @see MyOtherClass#do_something

@deprecated Use {MyOtherClass#do_something} instead of this method because

that one is newer.

@private

@param [Array<String>] arr the arguments passed from input. This

array will be modified.

@param arr2 [Array<String, Symbol>] the list of strings and symbols. @param [Hash] opts the options to create a message with. @option opts [String] :subject The subject @option opts [String] :from ('nobody') From address @option opts [String] :to Recipient email @option opts [String] :body ('') The body

Some code snippet:

MyClass.new.do_something

@example Do someting

MyClass.new.do_something

@raise [RuntimeError] description

@return [String, nil] the successful result or nil

if an error occurred
# File lib/yard_doc_example.rb, line 50
def do_something(arr, arr2, opts:)
end