Class: Jazzy::SourceDeclaration

Inherits:
Object
  • Object
show all
Defined in:
lib/jazzy/source_declaration.rb,
lib/jazzy/source_declaration/type.rb,
lib/jazzy/source_declaration/access_control_level.rb

Defined Under Namespace

Classes: AccessControlLevel, Type

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#abstract ⇒ Object

Returns the value of attribute abstract.



13
14
15
 
# File 'lib/jazzy/source_declaration.rb', line 13

def abstract
  @abstract
end

#access_control_level ⇒ Object

Returns the value of attribute access_control_level.



20
21
22
 
# File 'lib/jazzy/source_declaration.rb', line 20

def access_control_level
  @access_control_level
end

#children ⇒ Object

Returns the value of attribute children.



16
17
18
 
# File 'lib/jazzy/source_declaration.rb', line 16

def children
  @children
end

#column ⇒ Object

Returns the value of attribute column.



9
10
11
 
# File 'lib/jazzy/source_declaration.rb', line 9

def column
  @column
end

#declaration ⇒ Object

Returns the value of attribute declaration.



12
13
14
 
# File 'lib/jazzy/source_declaration.rb', line 12

def declaration
  @declaration
end

#discussion ⇒ Object

Returns the value of attribute discussion.



14
15
16
 
# File 'lib/jazzy/source_declaration.rb', line 14

def discussion
  @discussion
end

#end_line ⇒ Object

Returns the value of attribute end_line.



22
23
24
 
# File 'lib/jazzy/source_declaration.rb', line 22

def end_line
  @end_line
end

#file ⇒ Object

Returns the value of attribute file.



7
8
9
 
# File 'lib/jazzy/source_declaration.rb', line 7

def file
  @file
end

#line ⇒ Object

Returns the value of attribute line.



8
9
10
 
# File 'lib/jazzy/source_declaration.rb', line 8

def line
  @line
end

#mark ⇒ Object

Returns the value of attribute mark.



19
20
21
 
# File 'lib/jazzy/source_declaration.rb', line 19

def mark
  @mark
end

#name ⇒ Object

Returns the value of attribute name.



11
12
13
 
# File 'lib/jazzy/source_declaration.rb', line 11

def name
  @name
end

#parameters ⇒ Object

Returns the value of attribute parameters.



17
18
19
 
# File 'lib/jazzy/source_declaration.rb', line 17

def parameters
  @parameters
end

#return ⇒ Object

Returns the value of attribute return.



15
16
17
 
# File 'lib/jazzy/source_declaration.rb', line 15

def return
  @return
end

#start_line ⇒ Object

Returns the value of attribute start_line.



21
22
23
 
# File 'lib/jazzy/source_declaration.rb', line 21

def start_line
  @start_line
end

#type ⇒ Object

Returns the value of attribute type.



6
7
8
 
# File 'lib/jazzy/source_declaration.rb', line 6

def type
  @type
end

#url ⇒ Object

Returns the value of attribute url.



18
19
20
 
# File 'lib/jazzy/source_declaration.rb', line 18

def url
  @url
end

#usr ⇒ Object

Returns the value of attribute usr.



10
11
12
 
# File 'lib/jazzy/source_declaration.rb', line 10

def usr
  @usr
end

Instance Method Details

#overview ⇒ Object 



24
25
26
 
# File 'lib/jazzy/source_declaration.rb', line 24

def overview
  "#{abstract}\n\n#{discussion}".strip
end