Parent

Methods

Class/Module Index [+]

Quicksearch

Rabbit::READMEParser

Constants

HEADING_MARK_RE

Attributes

description[R]
logger[RW]
title[R]

Public Class Methods

new(logger=nil) click to toggle source
# File lib/rabbit/readme-parser.rb, line 27
def initialize(logger=nil)
  @logger = logger || Logger.default
  @title = nil
  @description = nil
end

Public Instance Methods

parse(path=nil) click to toggle source
# File lib/rabbit/readme-parser.rb, line 33
def parse(path=nil)
  path ||= remove_backup_paths(Dir.glob("README*"))[0]
  raise _("No README found") if path.nil?

  parse_content(File.read(path))
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.