Class RDoc::Markup::Line
In: lib/rdoc/markup/lines.rb
Parent: Object

We store the lines we‘re working on as objects of class Line. These contain the text of the line, along with a flag indicating the line type, and an indentation level.

Methods

blank?   new   stamp   strip_leading   to_s  

Constants

INFINITY = 9999
LINE_TYPES = [ :BLANK, :HEADING, :LIST, :PARAGRAPH, :RULE, :VERBATIM, ]

Attributes

deleted  [RW]  true if this line has been deleted from the list of lines
flag  [RW]  A flag. For list lines, this is the type of the list
leading_spaces  [RW]  the number of leading spaces
level  [RW]  The indentation nesting level
param  [RW]  A prefix or parameter. For LIST lines, this is the text that introduced the list item (the label)
text  [RW]  The contents
type  [RW]  line type

Public Class methods

Public Instance methods

blank?()

Return true if this line is blank

stamp(type, level, param="", flag=nil)

stamp a line with a type, a level, a prefix, and a flag

strip_leading(size)

Strip off the leading margin

[Validate]

ruby-doc.org is a community service provided by Happy Camper Studios, a Phoenix, Arizona, Ruby application development company.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.