class Peeky::Example::YardSample

Yard sample

Attributes

a_read_write1[RW]

A read write1

a_read_write2[RW]

A read write2

a_read_write3[RW]

A read write3

b_reader1[R]

B reader1

b_reader2[R]

B reader2

c_writer1[W]

C writer1

c_writer2[W]

C writer2

e_looks_like_an_attr_reader[R]

E looks like an attr reader

Public Instance Methods

alpha_sort1() click to toggle source

Alpha sort1

# File lib/peeky/example/yard_sample.rb, line 30
def alpha_sort1
end
alpha_sort2() click to toggle source

Alpha sort2

# File lib/peeky/example/yard_sample.rb, line 34
def alpha_sort2
end
d_do_something_method() click to toggle source

D do something method

# File lib/peeky/example/yard_sample.rb, line 38
def d_do_something_method
end
e_method_with_required_param(first_name) click to toggle source

E method with required param

@param first_name [String] first name (required)

# File lib/peeky/example/yard_sample.rb, line 44
def e_method_with_required_param(first_name)
end
f_method_with_required_param_and_optional_param(first_name, last_name = '') click to toggle source

F method with required param and optional param

@param first_name [String] first name (required) @param last_name [String] last_name is optional, defaults to ''

# File lib/peeky/example/yard_sample.rb, line 51
def f_method_with_required_param_and_optional_param(first_name, last_name = '')
end
g_method_with_required_param_and_two_optional_params(first_name, last_name = '', age = 21) click to toggle source

G method with required param and two optional params

@param first_name [String] first name (required) @param last_name [String] last_name is optional, defaults to '' @param age [Integer] age is optional, defaults to 21

# File lib/peeky/example/yard_sample.rb, line 59
def g_method_with_required_param_and_two_optional_params(first_name, last_name = '', age = 21)
end
h_list_of_optional_parameters(*command_args) click to toggle source

H list of optional parameters

@param command_args [Array<Object>] *command_args - list of command args

# File lib/peeky/example/yard_sample.rb, line 65
def h_list_of_optional_parameters(*command_args)
end
i_method_with_two_required_params_and_list_of_optional_params(first_name, last_name, *alias_names) click to toggle source

I method with two required params and list of optional params

@param first_name [String] first name (required) @param last_name [String] last name (required) @param alias_names [Array<Object>] *alias_names - list of alias names

# File lib/peeky/example/yard_sample.rb, line 73
def i_method_with_two_required_params_and_list_of_optional_params(first_name, last_name, *alias_names)
end
j_method_with_list_of_named_arguments(**options) click to toggle source

J method with list of named arguments

@param options [<key: value>…] **options - list of key/values

# File lib/peeky/example/yard_sample.rb, line 79
def j_method_with_list_of_named_arguments(**options)
end
jin(aaa) click to toggle source

Jin

@param aaa [String] aaa (required)

# File lib/peeky/example/yard_sample.rb, line 85
def jin(aaa)
end
k_method_with_block(&code_block) click to toggle source

K method with block

@param code_block [Block] &code_block

# File lib/peeky/example/yard_sample.rb, line 91
def k_method_with_block(&code_block)
end
l_method_with_key_value_param_required(name:) click to toggle source

L method with key value param required

@param name [String] name: <value for name> (required)

# File lib/peeky/example/yard_sample.rb, line 97
def l_method_with_key_value_param_required(name:)
end
n_method_with_key_value_param_required_and_optional_key_value(last_name:, salutation: 'Mr') click to toggle source

N method with key value param required and optional key value

@param last_name [String] last_name: <value for last name> (required) @param salutation [String] salutation: is optional, defaults to 'Mr'

# File lib/peeky/example/yard_sample.rb, line 104
def n_method_with_key_value_param_required_and_optional_key_value(last_name:, salutation: 'Mr')
end
p_available?() click to toggle source

@return [Boolean] true when p available?

# File lib/peeky/example/yard_sample.rb, line 110
def p_available?
end
q_danger_will_robinson!() click to toggle source

Q danger will robinson!

# File lib/peeky/example/yard_sample.rb, line 114
def q_danger_will_robinson!
end
z_complex(aaa, bbb = 1, *ccc, ddd:, eee: 1, **fff, &ggg) click to toggle source

Z complex

@param aaa [String] aaa (required) @param bbb [Integer] bbb is optional, defaults to 1 @param ccc [Array<Object>] *ccc - list of ccc @param ddd [String] ddd: <value for ddd> (required) @param eee [Integer] eee: is optional, defaults to 1 @param fff [<key: value>…] **fff - list of key/values @param ggg [Block] &ggg

# File lib/peeky/example/yard_sample.rb, line 126
def z_complex(aaa, bbb = 1, *ccc, ddd:, eee: 1, **fff, &ggg)
end
z_optional_styles(aaa, bbb = 123, ccc = 'abc', ddd = true, eee = false, fff = nil, ggg: 123, hhh: 'xyz', iii: true, jjj: false, kkk: ) click to toggle source

Z optional styles

@param aaa [String] aaa (required) @param bbb [Integer] bbb is optional, defaults to 123 @param ccc [String] ccc is optional, defaults to 'abc' @param ddd [TrueClass] ddd is optional, defaults to true @param eee [FalseClass] eee is optional, defaults to false @param fff [Object] fff is optional, defaults to nil @param ggg [Integer] ggg: is optional, defaults to 123 @param hhh [String] hhh: is optional, defaults to 'xyz' @param iii [TrueClass] iii: is optional, defaults to true @param jjj [FalseClass] jjj: is optional, defaults to false @param kkk [Object] kkk: is optional, defaults to nil

# File lib/peeky/example/yard_sample.rb, line 142
def z_optional_styles(aaa, bbb = 123, ccc = 'abc', ddd = true, eee = false, fff = nil, ggg: 123, hhh: 'xyz', iii: true, jjj: false, kkk: )
end