Module: YardDocExample

Defined in:
lib/yard_doc_example.rb

Overview

Description of the module

Since:

  • 0.6.0

Defined Under Namespace

Classes: MyClass, MyOtherClass

Instance Attribute Summary collapse

Instance Attribute Details

#count ⇒ Number (readonly)

Returns the number of items.

Returns:

  • (Number) —

    the number of items



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/yard_doc_example.rb', line 21

class MyClass
  #
  # @see http://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
  def do_something(arr, arr2, opts:)
  end
end