class KnifeCookbookDoc::RecipeModel

Attributes

name[R]
short_description[R]

Public Class Methods

new(name, short_description = nil, filename) click to toggle source
# File lib/knife_cookbook_doc/recipe_model.rb, line 8
def initialize(name, short_description = nil, filename)
  @name = name
  @short_description = short_description
  @filename = filename
  load_descriptions
end

Private Instance Methods

load_descriptions() click to toggle source
# File lib/knife_cookbook_doc/recipe_model.rb, line 17
def load_descriptions
  current_section = 'main'
  description = extract_description
  description.each_line do |line|
    if /^ *\@section (.*)$/ =~ line
      current_section = $1.strip
    else
      lines = (top_level_descriptions[current_section] || [])
      lines << line.gsub("\n",'')
      top_level_descriptions[current_section] = lines
    end
  end
  if @short_description.nil?
    @short_description = first_sentence(description) || ""
  end
end