Class: RDoc::RD::Inline
Relationships & Source Files | |
Inherits: | Object |
Defined in: | lib/rdoc/rd/inline.rb |
Overview
Inline
keeps track of markup and labels to create proper links.
Class Method Summary
-
.new(rdoc, reference = rdoc) ⇒ Inline
constructor
Creates a new
Inline
for #rdoc and #reference.
Instance Attribute Summary
-
#rdoc
(also: #to_s)
readonly
The markup of this reference in
::RDoc::RDoc
format. -
#reference
readonly
The text of the reference.
-
#to_s
readonly
Internal use only
::RDoc::Alias
for #rdoc.
Instance Method Summary
-
#append(more)
Appends
more
to this inline. -
#initialize(rdoc, reference) ⇒ Inline
constructor
Initializes the
Inline
with #rdoc andinline
- #==(other) Internal use only
- #inspect Internal use only
Constructor Details
.new(rdoc, reference = rdoc) ⇒ Inline
Creates a new Inline
for #rdoc and #reference.
#rdoc may be another Inline
or a String. If #reference is not given it will use the text from #rdoc.
#initialize(rdoc, reference) ⇒ Inline
Initializes the Inline
with #rdoc and inline
Instance Attribute Details
#rdoc (readonly) Also known as: #to_s
The markup of this reference in ::RDoc::RDoc
format
# File 'lib/rdoc/rd/inline.rb', line 15
attr_reader :rdoc
#reference (readonly)
The text of the reference
# File 'lib/rdoc/rd/inline.rb', line 10
attr_reader :reference
#to_s (readonly)
This method is for internal use only.
::RDoc::Alias
for #rdoc.
# File 'lib/rdoc/rd/inline.rb', line 69
alias to_s rdoc # :nodoc:
Instance Method Details
#==(other)
This method is for internal use only.
[ GitHub ]
#append(more)
Appends more
to this inline. more
may be a String or another Inline
.
#inspect
This method is for internal use only.
[ GitHub ]
# File 'lib/rdoc/rd/inline.rb', line 65
def inspect # :nodoc: "(inline: #{self})" end