Class: Shaf::Yard::ProfileObject

Inherits:
YARD::CodeObjects::ClassObject
  • Object
show all
Defined in:
lib/shaf/yard/profile_object.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#profile ⇒ Object

Returns the value of attribute profile.



6
7
8
 
# File 'lib/shaf/yard/profile_object.rb', line 6

def profile
  @profile
end

Instance Method Details

#description ⇒ Object 



12
13
14
 
# File 'lib/shaf/yard/profile_object.rb', line 12

def description
  profile&.doc || ""
end

#path ⇒ Object 



8
9
10
 
# File 'lib/shaf/yard/profile_object.rb', line 8

def path
  "Profiles::#{name}"
end

#profile_name ⇒ Object 



16
17
18
 
# File 'lib/shaf/yard/profile_object.rb', line 16

def profile_name
  name.to_s.sub(/Profile\z/, '')
end