Module: KnifeCookbookDoc::BaseModel

Included in:
DefinitionsModel, RecipeModel, ResourceModel
Defined in:
lib/knife_cookbook_doc/base_model.rb

Instance Method Summary collapse

Instance Method Details

#short_description ⇒ Object 



12
13
14
15
16
17
 
# File 'lib/knife_cookbook_doc/base_model.rb', line 12

def short_description
  unless @short_description
    @short_description = first_sentence(top_level_description('main'))
  end
  @short_description
end

#top_level_description(section) ⇒ Object 



4
5
6
 
# File 'lib/knife_cookbook_doc/base_model.rb', line 4

def top_level_description(section)
  (top_level_descriptions[section.to_s] || []).join("\n").gsub(/\n+$/m,"\n")
end

#top_level_descriptions ⇒ Object 



8
9
10
 
# File 'lib/knife_cookbook_doc/base_model.rb', line 8

def top_level_descriptions
  @top_level_descriptions ||= {}
end