Class: Peeky::Example::YardSample

Inherits:
Object
  • Object
show all
Defined in:
lib/peeky/example/yard_sample.rb

Overview

Yard sample

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#a_read_write1Object

A read write1


6
7
8
# File 'lib/peeky/example/yard_sample.rb', line 6

def a_read_write1
  @a_read_write1
end

#a_read_write2Object

A read write2


9
10
11
# File 'lib/peeky/example/yard_sample.rb', line 9

def a_read_write2
  @a_read_write2
end

#a_read_write3Object

A read write3


12
13
14
# File 'lib/peeky/example/yard_sample.rb', line 12

def a_read_write3
  @a_read_write3
end

#b_reader1Object (readonly)

B reader1


15
16
17
# File 'lib/peeky/example/yard_sample.rb', line 15

def b_reader1
  @b_reader1
end

#b_reader2Object (readonly)

B reader2


18
19
20
# File 'lib/peeky/example/yard_sample.rb', line 18

def b_reader2
  @b_reader2
end

#c_writer1=(value) ⇒ Object (writeonly)

C writer1


24
25
26
# File 'lib/peeky/example/yard_sample.rb', line 24

def c_writer1=(value)
  @c_writer1 = value
end

#c_writer2=(value) ⇒ Object (writeonly)

C writer2


27
28
29
# File 'lib/peeky/example/yard_sample.rb', line 27

def c_writer2=(value)
  @c_writer2 = value
end

#e_looks_like_an_attr_readerObject (readonly)

E looks like an attr reader


21
22
23
# File 'lib/peeky/example/yard_sample.rb', line 21

def e_looks_like_an_attr_reader
  @e_looks_like_an_attr_reader
end

Instance Method Details

#alpha_sort1Object

Alpha sort1


30
31
# File 'lib/peeky/example/yard_sample.rb', line 30

def alpha_sort1
end

#alpha_sort2Object

Alpha sort2


34
35
# File 'lib/peeky/example/yard_sample.rb', line 34

def alpha_sort2
end

#d_do_something_methodObject

D do something method


38
39
# File 'lib/peeky/example/yard_sample.rb', line 38

def d_do_something_method
end

#e_method_with_required_param(first_name) ⇒ Object

E method with required param

Parameters:

  • first_name (String)

    first name (required)


44
45
# 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 = nil) ⇒ Object

F method with required param and optional param

Parameters:

  • first_name (String)

    first name (required)

  • last_name (String) (defaults to: nil)

    last name (optional)


51
52
# File 'lib/peeky/example/yard_sample.rb', line 51

def f_method_with_required_param_and_optional_param(first_name, last_name = nil)
end

#g_method_with_required_param_and_two_optional_params(first_name, last_name = nil, age = nil) ⇒ Object

G method with required param and two optional params

Parameters:

  • first_name (String)

    first name (required)

  • last_name (String) (defaults to: nil)

    last name (optional)

  • age (String) (defaults to: nil)

    age (optional)


59
60
# File 'lib/peeky/example/yard_sample.rb', line 59

def g_method_with_required_param_and_two_optional_params(first_name, last_name = nil, age = nil)
end

#h_list_of_optional_parameters(*command_args) ⇒ Object

H list of optional parameters

Parameters:

  • command_args (Array<Object>)

    *command_args - list of command args


65
66
# 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) ⇒ Object

I method with two required params and list of optional params

Parameters:

  • first_name (String)

    first name (required)

  • last_name (String)

    last name (required)

  • alias_names (Array<Object>)

    *alias_names - list of alias names


73
74
# 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) ⇒ Object

J method with list of named arguments

Parameters:

  • options (<key: value>...)

    **options - list of key/values


79
80
# File 'lib/peeky/example/yard_sample.rb', line 79

def j_method_with_list_of_named_arguments(**options)
end

#k_method_with_block(&code_block) ⇒ Object

K method with block

Parameters:

  • code_block (Block)

    &code_block


85
86
# File 'lib/peeky/example/yard_sample.rb', line 85

def k_method_with_block(&code_block)
end

#l_method_with_key_value_param_required(name:) ⇒ Object

L method with key value param required

Parameters:

  • name (String)

    name: <value for name> (required)


91
92
# File 'lib/peeky/example/yard_sample.rb', line 91

def l_method_with_key_value_param_required(name:)
end

#n_method_with_key_value_param_required_and_optional_key_value(last_name:, salutation: nil) ⇒ Object

N method with key value param required and optional key value

Parameters:

  • last_name (String)

    last_name: <value for last name> (required)

  • salutation (String) (defaults to: nil)

    salutation: <value for salutation> (optional)


98
99
# File 'lib/peeky/example/yard_sample.rb', line 98

def n_method_with_key_value_param_required_and_optional_key_value(last_name:, salutation: nil)
end

#p_available?Boolean

Returns true when p available?.

Returns:

  • (Boolean)

    true when p available?


104
105
# File 'lib/peeky/example/yard_sample.rb', line 104

def p_available?
end

#q_danger_will_robinson!Object

Q danger will robinson!


108
109
# File 'lib/peeky/example/yard_sample.rb', line 108

def q_danger_will_robinson!
end

#z_complex(aaa, bbb = nil, *ccc, ddd:, eee: nil, **fff, &ggg) ⇒ Object

Z complex

Parameters:

  • aaa (String)

    aaa (required)

  • bbb (String) (defaults to: nil)

    bbb (optional)

  • ccc (Array<Object>)

    *ccc - list of ccc

  • ddd (String)

    ddd: <value for ddd> (required)

  • eee (String) (defaults to: nil)

    eee: <value for eee> (optional)

  • fff (<key: value>...)

    **fff - list of key/values

  • ggg (Block)

    &ggg


120
121
# File 'lib/peeky/example/yard_sample.rb', line 120

def z_complex(aaa, bbb = nil, *ccc, ddd:, eee: nil, **fff, &ggg)
end