class Peeky::Example::YardSample
Yard sample
Attributes
A read write1
A read write2
A read write3
B reader1
B reader2
C writer1
C writer2
E looks like an attr reader
Public Instance Methods
Alpha sort1
# File lib/peeky/example/yard_sample.rb, line 30 def alpha_sort1 end
Alpha sort2
# File lib/peeky/example/yard_sample.rb, line 34 def alpha_sort2 end
D do something method
# File lib/peeky/example/yard_sample.rb, line 38 def d_do_something_method end
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
@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
@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
@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
@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
@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
@param aaa [String] aaa (required)
# File lib/peeky/example/yard_sample.rb, line 85 def jin(aaa) end
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
@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
@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
@return [Boolean] true when p available?
# File lib/peeky/example/yard_sample.rb, line 110 def p_available? end
Q danger will robinson!
# File lib/peeky/example/yard_sample.rb, line 114 def q_danger_will_robinson! end
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
@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