D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
proc
/
self
/
root
/
opt
/
alt
/
ruby34
/
share
/
ri
/
system
/
RDoc
/
MarkupReference
/
Filename :
cdesc-MarkupReference.ri
back
Copy
U:RDoc::NormalClass[iI"MarkupReference:ETI"RDoc::MarkupReference;TI" Object;To:RDoc::Markup::Document: @parts[o;;[ o: RDoc::Markup::Paragraph;[I"J\Class \RDoc::MarkupReference exists only to provide a suitable home ;TI"/for a reference document for \RDoc markup.;To: RDoc::Markup::BlankLine o; ;[I"NAll objects defined in this class -- classes, modules, methods, aliases, ;TI"Lattributes, and constants -- are solely for illustrating \RDoc markup, ;TI"&and have no other legitimate use.;T@S:RDoc::Markup::Heading: leveli: textI"About the Examples;T@o:RDoc::Markup::List: @type: BULLET: @items[o:RDoc::Markup::ListItem: @label0;[o; ;[I"<Examples in this reference are Ruby code and comments; ;TI",certain differences from other sources ;TI"-(such as C code and comments) are noted.;To;;0;[o; ;[I"9Almost all examples on this page are all RDoc-like; ;TI"Ithat is, they have no explicit comment markers like Ruby <tt>#</tt> ;TI" or C <tt>/* ... */</tt>.;To;;0;[o; ;[I"0An example that shows rendered HTML output ;TI"*displays that output in a blockquote:;T@o: RDoc::Markup::BlockQuote;[o; ;[I"Some stuff;T@S; ; i; I"\RDoc Sources;T@o; ;[I"KThe sources of \RDoc documentation vary according to the type of file:;T@o;;;;[o;;0;[o; ;[I"#<tt>.rb</tt> (Ruby code file):;T@o;;;;[o;;0;[o; ;[ I"+Markup may be found in Ruby comments: ;TI"8A comment that immediately precedes the definition ;TI"Dof a Ruby class, module, method, alias, constant, or attribute ;TI"7becomes the documentation for that defined object.;To;;0;[o; ;[I"(An \RDoc directive may be found in:;T@o;;;;[o;;0;[o; ;[I"4A trailing comment (on the same line as code); ;TI"Asee <tt>:nodoc:</tt>, <tt>:doc:</tt>, and <tt>:notnew:</tt>.;To;;0;[o; ;[I" A single-line comment; ;TI"Gsee other {Directives}[rdoc-ref:RDoc::MarkupReference@Directives].;T@o;;0;[o; ;[I"=Documentation may be derived from the Ruby code itself; ;TI"usee {Documentation Derived from Ruby Code}[rdoc-ref:RDoc::MarkupReference@Documentation+Derived+from+Ruby+Code].;T@o;;0;[o; ;[ I"B<tt>.c</tt> (C code file): markup is parsed from C comments. ;TI")A comment that immediately precedes ;TI"/a function that implements a Ruby method, ;TI"Hor otherwise immediately precedes the definition of a Ruby object, ;TI"/becomes the documentation for that object.;To;;0;[o; ;[ I"Y<tt>.rdoc</tt> (\RDoc markup text file) or <tt>.md</tt> (\RDoc markdown text file): ;TI",markup is parsed from the entire file. ;TI"6The text is not associated with any code object, ;TI";but may (depending on how the documentation is built) ;TI" become a separate page.;T@o; ;[I" An <i>RDoc document</i>:;T@o;;;;[o;;0;[o; ;[I"9A (possibly multi-line) comment in a Ruby or C file ;TI"3that generates \RDoc documentation (as above).;To;;0;[o; ;[I"MThe entire markup (<tt>.rdoc</tt>) file or markdown (<tt>.md</tt>) file ;TI"#(which is usually multi-line).;T@S; ; i; I" Blocks;T@o; ;[I"MIt's convenient to think of an \RDoc document as a sequence of _blocks_ ;TI"-of various types (details at the links):;T@o;;;;[o;;0;[o; ;[I"={Paragraph}[rdoc-ref:RDoc::MarkupReference@Paragraphs]: ;TI"an ordinary paragraph.;To;;0;[o; ;[I"Q{Verbatim text block}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks]: ;TI".a block of text to be rendered literally.;To;;0;[o; ;[I"?{Code block}[rdoc-ref:RDoc::MarkupReference@Code+Blocks]: ;TI"1a verbatim text block containing Ruby code, ;TI"+to be rendered with code highlighting.;To;;0;[o; ;[I"A{Block quote}[rdoc-ref:RDoc::MarkupReference@Block+Quotes]: ;TI"?a longish quoted passage, to be rendered with indentation ;TI" instead of quote marks.;To;;0;[o; ;[I"={List}[rdoc-ref:RDoc::MarkupReference@Lists]: items for ;TI"Ba bullet list, numbered list, lettered list, or labeled list.;To;;0;[o; ;[I"9{Heading}[rdoc-ref:RDoc::MarkupReference@Headings]: ;TI"a heading.;To;;0;[o; ;[I"I{Horizontal rule}[rdoc-ref:RDoc::MarkupReference@Horizontal+Rules]: ;TI"%a line across the rendered page.;To;;0;[o; ;[I"={Directive}[rdoc-ref:RDoc::MarkupReference@Directives]: ;TI"2various special directions for the rendering.;To;;0;[o; ;[I"?{Text Markup}[rdoc-ref:RDoc:MarkupReference@Text+Markup]: ;TI"*text to be rendered in a special way.;T@o; ;[I"About the blocks:;T@o;;;;[o;;0;[o; ;[I"JExcept for a paragraph, a block is distinguished by its indentation, ;TI"2or by unusual initial or embedded characters.;To;;0;[o; ;[I"(Any block may appear independently ;TI"-(that is, not nested in another block); ;TI"2some blocks may be nested, as detailed below.;To;;0;[o; ;[ I" In a multi-line block, ;TI"6\RDoc looks for the block's natural left margin, ;TI":which becomes the <em>base margin</em> for the block ;TI">and is the initial <em>current margin</em> for the block.;T@S; ; i ; I"Paragraphs;T@o; ;[I"KA paragraph consists of one or more non-empty lines of ordinary text, ;TI"*each beginning at the current margin.;T@o; ;[I"SNote: Here, <em>ordinary text</em> means text that is <em>not identified</em> ;TI"Cby indentation, or by unusual initial or embedded characters. ;TI"See below.;T@o; ;[I"9Paragraphs are separated by one or more empty lines.;T@o; ;[I"Example input:;T@o:RDoc::Markup::Verbatim;[ I"K\RDoc produces HTML and command-line documentation for Ruby projects. ;TI"H\RDoc includes the rdoc and ri tools for generating and displaying ;TI"*documentation from the command-line. ;TI" ;TI"You'll love it. ;T: @format0o; ;[I"Rendered HTML:;To;;[ o; ;[I"K\RDoc produces HTML and command-line documentation for Ruby projects. ;TI"H\RDoc includes the rdoc and ri tools for generating and displaying ;TI")documentation from the command-line.;T@o; ;[I"You'll love it.;T@o; ;[I"6A paragraph may contain nested blocks, including:;T@o;;;;[ o;;0;[o; ;[I"Q{Verbatim text blocks}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks].;To;;0;[o; ;[I"?{Code blocks}[rdoc-ref:RDoc::MarkupReference@Code+Blocks].;To;;0;[o; ;[I"A{Block quotes}[rdoc-ref:RDoc::MarkupReference@Block+Quotes].;To;;0;[o; ;[I"3{Lists}[rdoc-ref:RDoc::MarkupReference@Lists].;To;;0;[o; ;[I"9{Headings}[rdoc-ref:RDoc::MarkupReference@Headings].;To;;0;[o; ;[I"I{Horizontal rules}[rdoc-ref:RDoc::MarkupReference@Horizontal+Rules].;To;;0;[o; ;[I">{Text Markup}[rdoc-ref:RDoc:MarkupReference@Text+Markup].;T@S; ; i ; I"Verbatim Text Blocks;T@o; ;[I"ZText indented farther than the current margin becomes a <em>verbatim text block</em> ;TI"((or a code block, described next). ;TI"%In the rendered HTML, such text:;T@o;;;;[o;;0;[o; ;[I"Is indented.;To;;0;[o; ;[I"(Has a contrasting background color.;T@o; ;[I"TThe verbatim text block ends at the first line beginning at the current margin.;T@o; ;[I"Example input:;T@o;;[I" This is not verbatim text. ;TI" ;TI" This is verbatim text. ;TI"+ Whitespace is honored. # See? ;TI"- Whitespace is honored. # See? ;TI" ;TI"3 This is still the same verbatim text block. ;TI" ;TI" This is not verbatim text. ;T;0o; ;[I"Rendered HTML:;To;;[ o; ;[I" This is not verbatim text.;T@o;;[ I" This is verbatim text. ;TI") Whitespace is honored. # See? ;TI"+ Whitespace is honored. # See? ;TI" ;TI"1This is still the same verbatim text block. ;T;0o; ;[I" This is not verbatim text.;T@o; ;[I"EA verbatim text block may not contain nested blocks of any kind ;TI"-- it's verbatim.;T@S; ; i ; I"Code Blocks;T@o; ;[I"AA special case of verbatim text is the <em>code block</em>, ;TI"Fwhich is merely verbatim text that \RDoc recognizes as Ruby code:;T@o; ;[I"*In the rendered HTML, the code block:;T@o;;;;[o;;0;[o; ;[I"Is indented.;To;;0;[o; ;[I"(Has a contrasting background color.;To;;0;[o; ;[I" Has syntax highlighting.;T@o; ;[I"Example input:;T@o;;[ I"Consider this method: ;TI" ;TI"% def foo(name = '', value = 0) ;TI": @name = name # Whitespace is still honored. ;TI" @value = value ;TI" end ;T;0o; ;[I"Rendered HTML:;To;;[o; ;[I"Consider this method:;T@o;;[ I"#def foo(name = '', value = 0) ;TI"8 @name = name # Whitespace is still honored. ;TI" @value = value ;TI" end ;T;0o; ;[I"DPro tip: If your indented Ruby code does not get highlighted, ;TI"#it may contain a syntax error.;T@o; ;[I"<A code block may not contain nested blocks of any kind ;TI"-- it's verbatim.;T@S; ; i ; I"Block Quotes;T@o; ;[I";You can use the characters <tt>>>></tt> (unindented), ;TI"2followed by indented text, to treat the text ;TI"Gas a {block quote}[https://en.wikipedia.org/wiki/Block_quotation]:;T@o; ;[I"Example input:;T@o;;[I"Here's a block quote: ;TI" >>> ;TI"H Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer ;TI"L commodo quam iaculis massa posuere, dictum fringilla justo pulvinar. ;TI"M Quisque turpis erat, pharetra eu dui at, sollicitudin accumsan nulla. ;TI" ;TI"F Aenean congue ligula eu ligula molestie, eu pellentesque purus ;TI"M faucibus. In id leo non ligula condimentum lobortis. Duis vestibulum, ;TI"K diam in pellentesque aliquet, mi tellus placerat sapien, id euismod ;TI" purus magna ut tortor. ;T;0o; ;[I"Rendered HTML:;T@o;;[o; ;[I"Here's a block quote:;To;;[ o; ;[I"FLorem ipsum dolor sit amet, consectetur adipiscing elit. Integer ;TI"Jcommodo quam iaculis massa posuere, dictum fringilla justo pulvinar. ;TI"JQuisque turpis erat, pharetra eu dui at, sollicitudin accumsan nulla.;T@o; ;[ I"DAenean congue ligula eu ligula molestie, eu pellentesque purus ;TI"Kfaucibus. In id leo non ligula condimentum lobortis. Duis vestibulum, ;TI"Idiam in pellentesque aliquet, mi tellus placerat sapien, id euismod ;TI"purus magna ut tortor.;T@o; ;[I"GNote that, unlike verbatim text, single newlines are not honored, ;TI"Ibut that a double newline begins a new paragraph in the block quote.;T@o; ;[I"8A block quote may contain nested blocks, including:;T@o;;;;[ o;;0;[o; ;[I"Other block quotes.;To;;0;[o; ;[I"={Paragraphs}[rdoc-ref:RDoc::MarkupReference@Paragraphs].;To;;0;[o; ;[I"Q{Verbatim text blocks}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks].;To;;0;[o; ;[I"?{Code blocks}[rdoc-ref:RDoc::MarkupReference@Code+Blocks].;To;;0;[o; ;[I"3{Lists}[rdoc-ref:RDoc::MarkupReference@Lists].;To;;0;[o; ;[I"9{Headings}[rdoc-ref:RDoc::MarkupReference@Headings].;To;;0;[o; ;[I"I{Horizontal rules}[rdoc-ref:RDoc::MarkupReference@Horizontal+Rules].;To;;0;[o; ;[I">{Text Markup}[rdoc-ref:RDoc:MarkupReference@Text+Markup].;T@S; ; i ; I" Lists;T@o; ;[I"=Each type of list item is marked by a special beginning:;T@o;;;;[ o;;0;[o; ;[I"8Bullet list item: Begins with a hyphen or asterisk.;To;;0;[o; ;[I"9Numbered list item: Begins with digits and a period.;To;;0;[o; ;[I"JLettered list item: Begins with an alphabetic character and a period.;To;;0;[o; ;[I"+Labeled list item: Begins with one of:;To;;;;[o;;0;[o; ;[I"Square-bracketed text.;To;;0;[o; ;[I"#A word followed by two colons.;T@o; ;[I"LA list begins with a list item and continues, even across blank lines, ;TI"Tas long as list items of the same type are found at the same indentation level.;T@o; ;[I"2A new list resets the current margin inward. ;TI"5Additional lines of text aligned at that margin ;TI"*are part of the continuing list item.;T@o; ;[I"GA list item may be continued on additional lines that are aligned ;TI".with the first line. See examples below.;T@o; ;[I"6A list item may contain nested blocks, including:;T@o;;;;[ o;;0;[o; ;[I" Other lists of any type.;To;;0;[o; ;[I"={Paragraphs}[rdoc-ref:RDoc::MarkupReference@Paragraphs].;To;;0;[o; ;[I"Q{Verbatim text blocks}[rdoc-ref:RDoc::MarkupReference@Verbatim+Text+Blocks].;To;;0;[o; ;[I"?{Code blocks}[rdoc-ref:RDoc::MarkupReference@Code+Blocks].;To;;0;[o; ;[I"A{Block quotes}[rdoc-ref:RDoc::MarkupReference@Block+Quotes].;To;;0;[o; ;[I"9{Headings}[rdoc-ref:RDoc::MarkupReference@Headings].;To;;0;[o; ;[I"I{Horizontal rules}[rdoc-ref:RDoc::MarkupReference@Horizontal+Rules].;To;;0;[o; ;[I">{Text Markup}[rdoc-ref:RDoc:MarkupReference@Text+Markup].;T@S; ; i ; I"Bullet Lists;T@o; ;[I"9A bullet list item begins with a hyphen or asterisk.;T@o; ;[I"Example input:;T@o;;[ I"- An item. ;TI"- Another. ;TI"- An item spanning ;TI" multiple lines. ;TI" ;TI"* Yet another. ;TI"- Last one. ;T;0o; ;[I"Rendered HTML:;To;;[o;;;;[ o;;0;[o; ;[I" An item.;To;;0;[o; ;[I" Another.;To;;0;[o; ;[I"An item spanning ;TI"multiple lines.;T@o;;0;[o; ;[I"Yet another.;To;;0;[o; ;[I"Last one.;T@S; ; i ; I"Numbered Lists;T@o; ;[I":A numbered list item begins with digits and a period.;T@o; ;[I"-The items are automatically re-numbered.;T@o; ;[I"Example input:;T@o;;[ I"100. An item. ;TI"10. Another. ;TI"1. An item spanning ;TI" multiple lines. ;TI" ;TI"1. Yet another. ;TI"1000. Last one. ;T;0o; ;[I"Rendered HTML:;To;;[o;;: NUMBER;[ o;;0;[o; ;[I" An item.;To;;0;[o; ;[I" Another.;To;;0;[o; ;[I"An item spanning ;TI"multiple lines.;T@o;;0;[o; ;[I"Yet another.;To;;0;[o; ;[I"Last one.;T@S; ; i ; I"Lettered Lists;T@o; ;[I";A lettered list item begins with letters and a period.;T@o; ;[I"/The items are automatically "re-lettered.";T@o; ;[I"Example input:;T@o;;[ I"z. An item. ;TI"y. Another. ;TI"x. An item spanning ;TI" multiple lines. ;TI" ;TI"x. Yet another. ;TI"a. Last one. ;T;0o; ;[I"Rendered HTML:;To;;[o;;: LALPHA;[ o;;0;[o; ;[I" An item.;To;;0;[o; ;[I" Another.;T@o;;0;[o; ;[I"Yet another.;To;;0;[o; ;[I"Last one.;T@S; ; i ; I"Labeled Lists;T@o; ;[I",A labeled list item begins with one of:;T@o;;;;[o;;0;[o; ;[I"@Square-bracketed text: the label and text are on two lines.;To;;0;[o; ;[I"LA word followed by two colons: the label and text are on the same line.;T@o; ;[I"Example input:;T@o;;[ I"[foo] An item. ;TI"bat:: Another. ;TI" [bag] An item spanning ;TI" multiple lines. ;TI" ;TI" [bar baz] Yet another. ;TI"bam:: Last one. ;T;0o; ;[I"Rendered HTML:;To;;[ o;;: LABEL;[o;;[I"foo;T;[o; ;[I" An item.;To;;: NOTE;[o;;[I"bat;T;[o; ;[I" Another.;To;;;;[o;;[I"bag;T;[o; ;[I"An item spanning ;TI"multiple lines.;T@o;;[I" bar baz;T;[o; ;[I"Yet another.;To;;;;[o;;[I"bam;T;[o; ;[I"Last one.;T@S; ; i ; I" Headings;T@o; ;[I"LA heading begins with up to six equal-signs, followed by heading text. ;TI"?Whitespace between those and the heading text is optional.;T@o; ;[I"Examples:;T@o;;[I"= Section 1 ;TI"== Section 1.1 ;TI"=== Section 1.1.1 ;TI"=== Section 1.1.2 ;TI"== Section 1.2 ;TI"= Section 2 ;TI" = Foo ;TI" == Bar ;TI" === Baz ;TI"==== Bam ;TI"===== Bat ;TI"====== Bad ;TI"+============Still a Heading (Level 6) ;TI"\== Not a Heading ;T;0o; ;[I"9A heading may contain only one type of nested block:;T@o;;;;[o;;0;[o; ;[I">{Text Markup}[rdoc-ref:RDoc:MarkupReference@Text+Markup].;T@S; ; i ; I"Horizontal Rules;T@o; ;[I"EA horizontal rule consists of a line with three or more hyphens ;TI"and nothing more.;T@o; ;[I"Example input:;T@o;;[ I" --- ;TI" --- Not a horizontal rule. ;TI" ;TI"$-- Also not a horizontal rule. ;TI" --- ;T;0o; ;[I"Rendered HTML:;To;;[ S:RDoc::Markup::Rule: weightio; ;[I" --- Not a horizontal rule.;T@o; ;[I"#-- Also not a horizontal rule.;TS;; i@S; ; i ; I"Directives;T@S; ; i ; I"9Directives for Allowing or Suppressing Documentation;T@o;;;;[ o;;0;[o; ;[I"<tt># :stopdoc:</tt>:;T@o;;;;[o;;0;[o; ;[I"!Appears on a line by itself.;To;;0;[o; ;[I"/Specifies that \RDoc should ignore markup ;TI"=until next <tt>:startdoc:</tt> directive or end-of-file.;T@o;;0;[o; ;[I"<tt># :startdoc:</tt>:;T@o;;;;[o;;0;[o; ;[I"!Appears on a line by itself.;To;;0;[o; ;[I"7Specifies that \RDoc should resume parsing markup.;T@o;;0;[o; ;[I"<tt># :enddoc:</tt>:;T@o;;;;[o;;0;[o; ;[I"!Appears on a line by itself.;To;;0;[o; ;[I">Specifies that \RDoc should ignore markup to end-of-file ;TI"$regardless of other directives.;T@o;;0;[o; ;[I"<tt># :nodoc:</tt>:;T@o;;;;[ o;;0;[o; ;[I" Appended to a line of code ;TI"Ithat defines a class, module, method, alias, constant, or attribute.;T@o;;0;[o; ;[I"@Specifies that the defined object should not be documented.;T@o;;0;[ o; ;[I"UFor a method definition in C code, it the directive must be in the comment line ;TI"*immediately preceding the definition:;T@o;;[ I"/* :nodoc: */ ;TI"static VALUE ;TI" some_method(VALUE self) ;TI"{ ;TI" return self; ;TI"} ;T;0o; ;[I"<Note that this directive has <em>no effect at all</em> ;TI"+when placed at the method declaration:;T@o;;[I"/* :nodoc: */ ;TI"Drb_define_method(cMyClass, "do_something", something_func, 0); ;T;0o; ;[I"KThe above comment is just a comment and has nothing to do with \RDoc. ;TI"ITherefore, +do_something+ method will be reported as "undocumented" ;TI"<unless that method or function is documented elsewhere.;T@o;;0;[o; ;[I"OFor a constant definition in C code, this directive <em>can not work</em> ;TI"?because there is no "implementation" place for a constant.;T@o;;0;[o; ;[I" <tt># :nodoc: all</tt>:;T@o;;;;[o;;0;[o; ;[I" Appended to a line of code ;TI"$that defines a class or module.;To;;0;[o; ;[I"BSpecifies that the class or module should not be documented. ;TI"HBy default, however, a nested class or module _will_ be documented.;T@o;;0;[o; ;[I"<tt># :doc:</tt>:;T@o;;;;[o;;0;[o; ;[I" Appended to a line of code ;TI"Ithat defines a class, module, method, alias, constant, or attribute.;To;;0;[o; ;[I"MSpecifies the defined object should be documented, even if it otherwise ;TI" would not be documented.;T@o;;0;[o; ;[I"P<tt># :notnew:</tt> (aliased as <tt>:not_new:</tt> and <tt>:not-new:</tt>):;T@o;;;;[o;;0;[o; ;[I" Appended to a line of code ;TI"/that defines instance method +initialize+.;To;;0;[o; ;[ I"ESpecifies that singleton method +new+ should not be documented. ;TI"DBy default, Ruby fakes a corresponding singleton method +new+, ;TI"0which \RDoc includes in the documentation. ;TI"JNote that instance method +initialize+ is private, and so by default ;TI"is not documented.;T@o; ;[I"5For Ruby code, but not for other \RDoc sources, ;TI"Ithere is a shorthand for <tt>:stopdoc:</tt> and <tt>:startdoc:</tt>:;T@o;;[ I"# Documented. ;TI" #-- ;TI"# Not documented. ;TI" #++ ;TI"# Documented. ;T;0o; ;[I"LFor C code, any of directives <tt>:startdoc:</tt>, <tt>:stopdoc:</tt>, ;TI"?and <tt>:enddoc:</tt> may appear in a stand-alone comment:;T@o;;[I"/* :startdoc: */ ;TI"/* :stopdoc: */ ;TI"/* :enddoc: */ ;T;0S; ; i ; I"1Directive for Specifying \RDoc Source Format;T@o;;;;[o;;0;[o; ;[I" <tt># :markup: _type_</tt>:;T@o;;;;[o;;0;[o; ;[I"!Appears on a line by itself.;To;;0;[o; ;[I"/Specifies the format for the \RDoc input; ;TI"Sparameter +type+ is one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+. ;TI"@See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].;T@S; ; i ; I"(Directives for Method Documentation;T@o;;;;[o;;0;[ o; ;[I"<tt># :call-seq:</tt>:;T@o;;;;[o;;0;[o; ;[I"!Appears on a line by itself.;To;;0;[o; ;[I"@Specifies the calling sequence to be reported in the HTML, ;TI"9overriding the actual calling sequence in the code. ;TI"$See method #call_seq_directive.;T@o; ;[ I"MNote that \RDoc can build the calling sequence for a Ruby-coded method, ;TI""but not for other languages. ;TI"NYou may want to override that by explicitly giving a <tt>:call-seq:</tt> ;TI"&directive if you want to include:;T@o;;;;[o;;0;[o; ;[I"8A return type, which is not automatically inferred.;To;;0;[o; ;[I" Multiple calling sequences.;T@o; ;[I"CFor C code, the directive may appear in a stand-alone comment.;T@o;;0;[o; ;[I"?<tt># :args: _arg_names_</tt> (aliased as <tt>:arg:</tt>):;T@o;;;;[o;;0;[o; ;[I"!Appears on a line by itself.;To;;0;[o; ;[I"9Specifies the arguments to be reported in the HTML, ;TI"2overriding the actual arguments in the code. ;TI" See method #args_directive.;T@o;;0;[o; ;[I"C<tt># :yields: _arg_names_</tt> (aliased as <tt>:yield:</tt>):;T@o;;;;[o;;0;[o; ;[I"!Appears on a line by itself.;To;;0;[o; ;[I"?Specifies the yield arguments to be reported in the HTML, ;TI".overriding the actual yield in the code. ;TI""See method #yields_directive.;T@S; ; i ; I",Directives for Organizing Documentation;T@o; ;[I" By default, \RDoc groups:;T@o;;;;[o;;0;[o; ;[I"6Singleton methods together in alphabetical order.;To;;0;[o; ;[I"GInstance methods and their aliases together in alphabetical order.;To;;0;[o; ;[I"AAttributes and their aliases together in alphabetical order.;T@o; ;[I"6You can use directives to modify those behaviors.;T@o;;;;[o;;0;[o; ;[I"*<tt># :section: _section_title_</tt>:;T@o;;;;[o;;0;[o; ;[I"!Appears on a line by itself.;To;;0;[o; ;[ I"ISpecifies that following methods are to be grouped into the section ;TI",with the given <em>section_title</em>, ;TI"7or into the default section if no title is given. ;TI"LThe directive remains in effect until another such directive is given, ;TI"Ibut may be temporarily overridden by directive <tt>:category:</tt>. ;TI"See below.;T@o; ;[I"1The comment block containing this directive:;T@o;;;;[o;;0;[o; ;[I"PMust be separated by a blank line from the documentation for the next item.;To;;0;[o; ;[I"9May have one or more lines preceding the directive. ;TI"KThese will be removed, along with any trailing lines that match them. ;TI"(Such lines may be visually helpful.;To;;0;[o; ;[I"GLines of text that are not so removed become the descriptive text ;TI"for the section.;T@o; ;[I" Example:;T@o;;[I"0# ---------------------------------------- ;TI" # :section: My Section ;TI")# This is the section that I wrote. ;TI"+# See it glisten in the noon-day sun. ;TI"0# ---------------------------------------- ;TI" ;TI"## ;TI" # Comment for some_method ;TI"def some_method ;TI" # ... ;TI" end ;T;0o; ;[I">You can use directive <tt>:category:</tt> to temporarily ;TI""override the current section.;T@o;;0;[o; ;[I"+<tt># :category: _section_title_</tt>:;T@o;;;;[o;;0;[o; ;[I"!Appears on a line by itself.;To;;0;[o; ;[I"@Specifies that just one following method is to be included ;TI"Kin the given section, or in the default section if no title is given. ;TI"CSubsequent methods are to be grouped into the current section.;T@S; ; i ; I"#Directive for Including a File;T@o;;;;[o;;0;[ o; ;[I"%<tt># :include: _filepath_</tt>:;T@o;;;;[o;;0;[o; ;[I"!Appears on a line by itself.;To;;0;[ o; ;[ I"3Specifies that the contents of the given file ;TI"'are to be included at this point. ;TI"KThe file content is shifted to have the same indentation as the colon ;TI"#at the start of the directive.;T@o; ;[I"LThe file is searched for in the directory containing the current file, ;TI"Kand then in each of the directories given with the <tt>--include</tt> ;TI"command-line option.;T@o; ;[I"BFor C code, the directive may appear in a stand-alone comment;T@S; ; i ; I"Text Markup;T@o; ;[I"9Text markup is metatext that affects HTML rendering:;T@o;;;;[ o;;0;[o; ;[I"&Typeface: italic, bold, monofont.;To;;0;[o; ;[I"FCharacter conversions: copyright, trademark, certain punctuation.;To;;0;[o; ;[I" Links.;To;;0;[o; ;[I"+Escapes: marking text as "not markup.";T@S; ; i ; I"Typeface Markup;T@o; ;[I"=Typeface markup can specify that text is to be rendered ;TI""as italic, bold, or monofont.;T@o; ;[I"?Typeface markup may contain only one type of nested block:;T@o;;;;[o;;0;[o; ;[I"More typeface markup: ;TI" italic, bold, monofont.;T@S; ; i ; I" Italic;T@o; ;[I"MText may be marked as italic via HTML tag <tt><i></tt> or <tt><em></tt>.;T@o; ;[I"Example input:;T@o;;[I"-<i>Italicized words</i> in a paragraph. ;TI" ;TI" >>> ;TI"1 <i>Italicized words in a block quote</i>. ;TI" ;TI"/- <i>Italicized words</i> in a list item. ;TI" ;TI"1====== <i>Italicized words</i> in a Heading ;TI" ;TI"A<i>Italicized passage containing *bold* and +monofont+.</i> ;T;0o; ;[I"Rendered HTML:;To;;[ o; ;[I",<i>Italicized words</i> in a paragraph.;T@o;;[o; ;[I".<i>Italicized words in a block quote</i>.;T@o;;;;[o;;0;[o; ;[I",<i>Italicized words</i> in a list item.;T@S; ; i ; I")<i>Italicized words</i> in a Heading;T@o; ;[I"@<i>Italicized passage containing *bold* and +monofont+.</i>;T@o; ;[I"6A single word may be italicized via a shorthand: ;TI"'prefixed and suffixed underscores.;T@o; ;[I"Example input:;T@o;;[ I" _Italic_ in a paragraph. ;TI" ;TI" >>> ;TI"" _Italic_ in a block quote. ;TI" ;TI" - _Italic_ in a list item. ;TI" ;TI""====== _Italic_ in a Heading ;T;0o; ;[I"Rendered HTML:;To;;[ o; ;[I" _Italic_ in a paragraph.;T@o;;[o; ;[I" _Italic_ in a block quote.;T@o;;;;[o;;0;[o; ;[I" _Italic_ in a list item.;T@S; ; i ; I"_Italic_ in a Heading;T@S; ; i ; I" Bold;T@o; ;[I":Text may be marked as bold via HTML tag <tt><b></tt>.;T@o; ;[I"Example input:;T@o;;[I"'<b>Bold words</b> in a paragraph. ;TI" ;TI" >>> ;TI"+ <b>Bold words</b> in a block quote. ;TI" ;TI")- <b>Bold words</b> in a list item. ;TI" ;TI"+====== <b>Bold words</b> in a Heading ;TI" ;TI"><b>Bold passage containing _italics_ and +monofont+.</b> ;T;0o; ;[I"Rendered HTML:;T@o;;[ o; ;[I"&<b>Bold words</b> in a paragraph.;T@o;;[o; ;[I"(<b>Bold words</b> in a block quote.;T@o;;;;[o;;0;[o; ;[I"&<b>Bold words</b> in a list item.;T@S; ; i ; I"#<b>Bold words</b> in a Heading;T@o; ;[I"=<b>Bold passage containing _italics_ and +monofont+.</b>;T@o; ;[I"5A single word may be made bold via a shorthand: ;TI"%prefixed and suffixed asterisks.;T@o; ;[I"Example input:;T@o;;[ I" *Bold* in a paragraph. ;TI" ;TI" >>> ;TI" *Bold* in a block quote. ;TI" ;TI" - *Bold* in a list item. ;TI" ;TI" ===== *Bold* in a Heading ;T;0o; ;[I"Rendered HTML:;T@o;;[ o; ;[I"*Bold* in a paragraph.;T@o;;[o; ;[I" *Bold* in a block quote.;T@o;;;;[o;;0;[o; ;[I"*Bold* in a list item.;T@S; ; i ; I"*Bold* in a Heading;T@S; ; i ; I" Monofont;T@o; ;[I"$Text may be marked as monofont ;TI".-- sometimes called 'typewriter font' -- ;TI"3via HTML tag <tt><tt></tt> or <tt><code></tt>.;T@o; ;[I"Example input:;T@o;;[I"-<tt>Monofont words</tt> in a paragraph. ;TI" ;TI" >>> ;TI"1 <tt>Monofont words</tt> in a block quote. ;TI" ;TI"/- <tt>Monofont words</tt> in a list item. ;TI" ;TI"/====== <tt>Monofont words</tt> in heading ;TI" ;TI"@<tt>Monofont passage containing _italics_ and *bold*.</tt> ;T;0o; ;[I"Rendered HTML:;T@o;;[ o; ;[I",<tt>Monofont words</tt> in a paragraph.;T@o;;[o; ;[I".<tt>Monofont words</tt> in a block quote.;T@o;;;;[o;;0;[o; ;[I",<tt>Monofont words</tt> in a list item.;T@S; ; i ; I"'<tt>Monofont words</tt> in heading;T@o; ;[I"?<tt>Monofont passage containing _italics_ and *bold*.</tt>;T@o; ;[I"8A single word may be made monofont by a shorthand: ;TI"&prefixed and suffixed plus-signs.;T@o; ;[I"Example input:;T@o;;[ I" +Monofont+ in a paragraph. ;TI" ;TI" >>> ;TI"$ +Monofont+ in a block quote. ;TI" ;TI""- +Monofont+ in a list item. ;TI" ;TI"$====== +Monofont+ in a Heading ;T;0o; ;[I"Rendered HTML:;T@o;;[ o; ;[I" +Monofont+ in a paragraph.;T@o;;[o; ;[I"!+Monofont+ in a block quote.;T@o;;;;[o;;0;[o; ;[I" +Monofont+ in a list item.;T@S; ; i ; I" +Monofont+ in a Heading;T@S; ; i ; I"Character Conversions;T@o; ;[I"PCertain combinations of characters may be converted to special characters; ;TI"Lwhether the conversion occurs depends on whether the special character ;TI"*is available in the current encoding.;T@o;;;;[ o;;0;[o; ;[I"K<tt>(c)</tt> converts to (c) (copyright character); must be lowercase.;T@o;;0;[o; ;[I"V<tt>(r)</tt> converts to (r) (registered trademark character); must be lowercase.;T@o;;0;[o; ;[I"<<tt>'foo'</tt> converts to 'foo' (smart single-quotes).;T@o;;0;[o; ;[I"<<tt>"foo"</tt> converts to "foo" (smart double-quotes).;T@o;;0;[o; ;[I"I<tt>foo ... bar</tt> converts to foo ... bar (1-character ellipsis).;T@o;;0;[o; ;[I"F<tt>foo -- bar</tt> converts to foo -- bar (1-character en-dash).;T@o;;0;[o; ;[I"H<tt>foo --- bar</tt> converts to foo --- bar (1-character em-dash).;T@S; ; i ; I" Links;T@o; ;[ I";Certain strings in \RDoc text are converted to links. ;TI"?Any such link may be suppressed by prefixing a backslash. ;TI"/This section shows how to link to various ;TI" targets.;T@o;;;;[o;;[I" Class;T;[ o;;;;[o;;0;[o; ;[I"6On-page: <tt>DummyClass</tt> links to DummyClass.;To;;0;[o; ;[I"9Off-page: <tt>RDoc::Alias</tt> links to RDoc::Alias.;T@o; ;[ I"CNote: For poeple want to mark up code (such as class, module, ;TI"Fconstant, and method) as "<tt>+code+</tt>" (for interoperability ;TI"Hwith other MarkDown parsers mainly), such word that refers a known ;TI"Hcode object and is marked up entirely and separately as "monofont" ;TI"!is also converted to a link.;T@o;;;;[o;;0;[o; ;[I".<tt>+DummyClass+</tt> links to DummyClass;To;;0;[o; ;[I"0<tt>+DummyClass-object+</tt> is not a link.;T@o;;[I" Module;T;[o;;;;[o;;0;[o; ;[I"8On-page: <tt>DummyModule</tt> links to DummyModule.;To;;0;[o; ;[I"+Off-page: <tt>RDoc</tt> links to RDoc.;T@o;;[I" Constant;T;[o;;;;[o;;0;[o; ;[I">On-page: <tt>DUMMY_CONSTANT</tt> links to DUMMY_CONSTANT.;To;;0;[o; ;[I"UOff-page: <tt>RDoc::Text::MARKUP_FORMAT</tt> links to RDoc::Text::MARKUP_FORMAT.;T@o;;[I"Singleton Method;T;[ o;;;;[o;;0;[o; ;[I"ROn-page: <tt>::dummy_singleton_method</tt> links to ::dummy_singleton_method.;To;;0;[o; ;[I"UOff-page<tt>RDoc::TokenStream::to_html</tt> links to RDoc::TokenStream::to_html.;T@o; ;[ I"CNote: Occasionally \RDoc is not linked to a method whose name ;TI"Mhas only special characters. Check whether the links you were expecting ;TI"Jare actually there. If not, you'll need to put in an explicit link; ;TI"see below.;T@o; ;[I"XPro tip: The link to any method is available in the alphabetical table of contents ;TI"9at the top left of the page for the class or module.;T@o;;[I"Instance Method;T;[o;;;;[o;;0;[o; ;[I"NOn-page: <tt>#dummy_instance_method</tt> links to #dummy_instance_method.;To;;0;[ o; ;[I"MOff-page: <tt>RDoc::Alias#html_name</tt> links to RDoc::Alias#html_name.;T@o; ;[I"0See the Note and Pro Tip immediately above.;T@o;;[I"Attribute;T;[o;;;;[o;;0;[o; ;[I"BOn-page: <tt>#dummy_attribute</tt> links to #dummy_attribute.;To;;0;[o; ;[I"COff-page: <tt>RDoc::Alias#name</tt> links to RDoc::Alias#name.;T@o;;[I" Alias;T;[o;;;;[o;;0;[o; ;[I"LOn-page: <tt>#dummy_instance_alias</tt> links to #dummy_instance_alias.;To;;0;[o; ;[I"KOff-page: <tt>RDoc::Alias#new_name</tt> links to RDoc::Alias#new_name.;T@o;;[I"Protocol +http+;T;[o;;;;[o;;0;[o; ;[I"ALinked: <tt>http://yahoo.com</tt> links to http://yahoo.com.;T@o;;[I"Protocol +https+;T;[o;;;;[o;;0;[o; ;[I"ELinked: <tt>https://github.com</tt> links to https://github.com.;T@o;;[I"Protocol +ftp+;T;[o;;;;[o;;0;[o; ;[I"CLinked: <tt>ftp://nosuch.site</tt> links to ftp://nosuch.site.;T@o;;[I"Protocol +mailto+;T;[o;;;;[o;;0;[o; ;[I"ILinked: <tt>mailto:/foo@bar.com</tt> links to mailto://foo@bar.com.;T@o;;[I"Protocol +irc+;T;[o;;;;[o;;0;[o; ;[I"Ulink: <tt>irc://irc.freenode.net/ruby</tt> links to irc://irc.freenode.net/ruby.;T@o;;[I" Image Filename Extensions;T;[o;;;;[o;;0;[ o; ;[I"PLink: <tt>https://www.ruby-lang.org/images/header-ruby-logo@2x.png</tt> is ;TI"Rconverted to an in-line HTML +img+ tag, which displays the image in the HTML:;T@o; ;[I"=https://www.ruby-lang.org/images/header-ruby-logo@2x.png;T@o; ;[I":Also works for +bmp+, +gif+, +jpeg+, and +jpg+ files.;T@o; ;[I"0Note: Works only for a fully qualified URL.;T@o;;[I" Heading;T;[ o;;;;[o;;0;[o; ;[I"ELink: <tt>RDoc::RD@LICENSE</tt> links to RDoc::RDoc::RD@LICENSE.;T@o; ;[I"UNote that spaces in the actual heading are represented by <tt>+</tt> characters ;TI"in the linkable text.;T@o;;;;[o;;0;[o; ;[I"0Link: <tt>RDoc::Options@Saved+Options</tt> ;TI"*links to RDoc::Options@Saved+Options.;T@o; ;[I"NPunctuation and other special characters must be escaped like CGI.escape.;T@o; ;[I"YPro tip: The link to any heading is available in the alphabetical table of contents ;TI"9at the top left of the page for the class or module.;T@o;;[I" Section;T;[ o; ;[I"See {Directives for Organizing Documentation}[#class-RDoc::MarkupReference-label-Directives+for+Organizing+Documentation].;T@o;;;;[o;;0;[o; ;[I"WLink: <tt>RDoc::Markup::ToHtml@Visitor</tt> links to RDoc::Markup::ToHtml@Visitor.;T@o; ;[I"TIf a section and a heading share the same name, the link target is the section.;T@o;;[I"Single-Word Text Link;T;[o; ;[I"9Use square brackets to create single-word text link:;T@o;;;;[o;;0;[o; ;[I"M<tt>GitHub[https://github.com]</tt> links to GitHub[https://github.com].;T@o;;[I"Multi-Word Text Link;T;[o; ;[I"KUse square brackets and curly braces to create a multi-word text link.;T@o;;;;[o;;0;[o; ;[I"><tt>{GitHub home page}[https://github.com]</tt> links to ;TI",{GitHub home page}[https://github.com].;T@o;;[I" <tt>rdoc-ref</tt> Scheme;T;[ o; ;[I"MA link with the <tt>rdoc-ref:</tt> scheme links to the referenced item, ;TI"if that item exists. ;TI"CThe referenced item may be a class, module, method, file, etc.;T@o;;;;[ o;;0;[o; ;[I"WClass: <tt>Alias[rdoc-ref:RDoc::Alias]</tt> generates Alias[rdoc-ref:RDoc::Alias].;To;;0;[o; ;[I"HModule: <tt>RDoc[rdoc-ref:RDoc]</tt> generates RDoc[rdoc-ref:RDoc].;To;;0;[o; ;[I"PMethod: <tt>foo[rdoc-ref:RDoc::MarkupReference#dummy_instance_method]</tt> ;TI"Igenerates foo[rdoc-ref:RDoc::MarkupReference#dummy_instance_method].;To;;0;[o; ;[I"LConstant: <tt>bar[rdoc-ref:RDoc::MarkupReference::DUMMY_CONSTANT]</tt> ;TI"Cgenerates bar[rdoc-ref:RDoc::MarkupReference::DUMMY_CONSTANT].;To;;0;[o; ;[I"MAttribute: <tt>baz[rdoc-ref:RDoc::MarkupReference#dummy_attribute]</tt> ;TI"Cgenerates baz[rdoc-ref:RDoc::MarkupReference#dummy_attribute].;To;;0;[o; ;[I"NAlias: <tt>bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias]</tt> ;TI"Hgenerates bad[rdoc-ref:RDoc::MarkupReference#dummy_instance_alias].;T@o; ;[I"AIf the referenced item does not exist, no link is generated ;TI"Fand entire <tt>rdoc-ref:</tt> square-bracketed clause is removed ;TI" from the resulting text.;T@o;;;;[o;;0;[o; ;[I"=<tt>Nosuch[rdoc-ref:RDoc::Nosuch]</tt> generates Nosuch.;T@o;;[I" <tt>rdoc-label</tt> Scheme;T;[o;;;;[o;;[I" Simple;T;[o; ;[I"4You can specify a link target using this form, ;TI";where the second part cites the id of an HTML element.;T@o; ;[I"DThis link refers to the constant +DUMMY_CONSTANT+ on this page:;T@o;;;;[o;;0;[o; ;[I"9<tt>{DUMMY_CONSTANT}[rdoc-label:DUMMY_CONSTANT]</tt>;T@o; ;[I" Thus:;T@o; ;[I"0{DUMMY_CONSTANT}[rdoc-label:DUMMY_CONSTANT];T@o;;[I"With Return;T;[o; ;[I":You can specify both a link target and a local label ;TI"7that can be used as the target for a return link. ;TI")These two links refer to each other:;T@o;;;;[o;;0;[o; ;[I"<<tt>{go to addressee}[rdoc-label:addressee:sender]</tt>;To;;0;[o; ;[I"=<tt>{return to sender}[rdoc-label:sender:addressee]</tt>;T@o; ;[I" Thus:;T@o; ;[I"3{go to addressee}[rdoc-label:addressee:sender];T@o; ;[I"Some text.;T@o; ;[I"4{return to sender}[rdoc-label:sender:addressee];T@o;;[I"<tt>link:</tt> Scheme;T;[o;;;;[o;;0;[o; ;[I"C<tt>link:README_rdoc.html</tt> links to link:README_rdoc.html.;T@o;;[I" <tt>rdoc-image</tt> Scheme;T;[ o; ;[I"PUse the <tt>rdoc-image</tt> scheme to display an image that is also a link:;T@o;;[I"/# {rdoc-image:path/to/image}[link_target] ;T;0o;;;;[o;;0;[ o; ;[I"uLink: <tt>{rdoc-image:https://www.ruby-lang.org/images/header-ruby-logo@2x.png}[https://www.ruby-lang.org]</tt> ;TI"Vdisplays image <tt>https://www.ruby-lang.org/images/header-ruby-logo@2x.png</tt> ;TI"5as a link to <tt>https://www.ruby-lang.org</tt>.;T@o; ;[I"e{rdoc-image:https://www.ruby-lang.org/images/header-ruby-logo@2x.png}[https://www.ruby-lang.org];T@o; ;[I".A relative path as the target also works:;T@o;;;;[o;;0;[ o; ;[I"�Link: <tt>{rdoc-image:https://www.ruby-lang.org/images/header-ruby-logo@2x.png}[./Alias.html]</tt> links to <tt>./Alias.html</tt>;T@o; ;[I"X{rdoc-image:https://www.ruby-lang.org/images/header-ruby-logo@2x.png}[./Alias.html];T@S; ; i; I"Escaping Text;T@o; ;[I"8Text that would otherwise be interpreted as markup ;TI"@can be "escaped," so that it is not interpreted as markup; ;TI";the escape character is the backslash (<tt>'\\'</tt>).;T@o; ;[I"/In a verbatim text block or a code block, ;TI".the escape character is always preserved:;T@o; ;[I"Example input:;T@o;;[I" This is not verbatim text. ;TI" ;TI": This is verbatim text, with an escape character \. ;TI" ;TI" This is not a code block. ;TI" ;TI" def foo ;TI", 'String with an escape character.' ;TI" end ;T;0o; ;[I"Rendered HTML:;T@o;;[ o; ;[I" This is not verbatim text.;T@o;;[I"8This is verbatim text, with an escape character \. ;T;0o; ;[I" This is not a code block.;T@o;;[I" def foo ;TI": 'This is a code block with an escape character \.' ;TI" end ;T;0o; ;[I"5In typeface markup (italic, bold, or monofont), ;TI"?an escape character is preserved unless it is immediately ;TI"(followed by nested typeface markup.;T@o; ;[I"Example input:;T@o;;[ I".This list is about escapes; it contains: ;TI" ;TI">- <tt>Monofont text with unescaped nested _italic_</tt>. ;TI"=- <tt>Monofont text with escaped nested \_italic_</tt>. ;TI":- <tt>Monofont text with an escape character \</tt>. ;T;0o; ;[I"Rendered HTML:;T@o;;[o; ;[I"-This list is about escapes; it contains:;T@o;;;;[o;;0;[o; ;[I";<tt>Monofont text with unescaped nested _italic_</tt>.;To;;0;[o; ;[I":<tt>Monofont text with escaped nested \_italic_</tt>.;To;;0;[o; ;[I"8<tt>Monofont text with an escape character \ </tt>.;T@o; ;[I""In other text-bearing blocks ;TI"6(paragraphs, block quotes, list items, headings):;T@o;;;;[ o;;0;[o; ;[I">A single escape character immediately followed by markup ;TI"escapes the markup.;To;;0;[o; ;[I"CA single escape character followed by whitespace is preserved.;To;;0;[o; ;[I"8A single escape character anywhere else is ignored.;To;;0;[ o; ;[I"AA double escape character is rendered as a single backslash.;T@o; ;[I"Example input:;T@o;;[ I".This list is about escapes; it contains: ;TI" ;TI"?- An unescaped class name, RDoc, that will become a link. ;TI"B- An escaped class name, \RDoc, that will not become a link. ;TI"6- An escape character followed by whitespace \ . ;TI"-- An escape character \that is ignored. ;TI"5- A double escape character \\ that is rendered ;TI" as a single backslash. ;T;0o; ;[I"Rendered HTML:;T@o;;[o; ;[I"-This list is about escapes; it contains:;T@o;;;;[ o;;0;[o; ;[I"<An unescaped class name, RDoc, that will become a link.;To;;0;[o; ;[I"?An escaped class name, \RDoc, that will not become a link.;To;;0;[o; ;[I"3An escape character followed by whitespace \ .;To;;0;[o; ;[I"*An escape character \that is ignored.;To;;0;[o; ;[I"3A double escape character \\ that is rendered ;TI"as a single backslash.;T@S; ; i; I")Documentation Derived from Ruby Code;T@o;;;;[ o;;[I" Class;T;[o; ;[I"!By default, \RDoc documents:;T@o;;;;[ o;;0;[o; ;[I"\Class name.;To;;0;[o; ;[I"Parent class.;To;;0;[o; ;[I"Singleton methods.;To;;0;[o; ;[I"Instance methods.;To;;0;[o; ;[I" Aliases.;To;;0;[o; ;[I"Constants.;To;;0;[o; ;[I"Attributes.;T@o;;[I" Module;T;[o; ;[I"!By default, \RDoc documents:;T@o;;;;[ o;;0;[o; ;[I"\Module name.;To;;0;[o; ;[I"\Singleton methods.;To;;0;[o; ;[I"Instance methods.;To;;0;[o; ;[I" Aliases.;To;;0;[o; ;[I"Constants.;To;;0;[o; ;[I"Attributes.;T@o;;[I" Method;T;[ o; ;[I"!By default, \RDoc documents:;T@o;;;;[o;;0;[o; ;[I"\Method name.;To;;0;[o; ;[I"Arguments.;To;;0;[o; ;[I"Yielded values.;T@o; ;[I"See #method.;T@o;;[I" Alias;T;[ o; ;[I"!By default, \RDoc documents:;T@o;;;;[o;;0;[o; ;[I"Alias name.;To;;0;[o; ;[I"Aliased name.;T@o; ;[I":See #dummy_instance_alias and #dummy_instance_method.;T@o;;[I" Constant;T;[ o; ;[I"!By default, \RDoc documents:;T@o;;;;[o;;0;[o; ;[I"\Constant name.;T@o; ;[I"See DUMMY_CONSTANT.;T@o;;[I"Attribute;T;[ o; ;[I"!By default, \RDoc documents:;T@o;;;;[o;;0;[o; ;[I"Attribute name.;To;;0;[o; ;[I"BAttribute type (<tt>[R]</tt>, <tt>[W]</tt>, or <tt>[RW]</tt>);T@o; ;[I"See #dummy_attribute.;T: @fileI" rdoc/markup_reference.rb;T:0@omit_headings_from_table_of_contents_below0; 0; 0[[ I"dummy_attribute;TI"RW;T: publicFI"!doc/rdoc/markup_reference.rb;T[ I"dummy_attribute_alias;T@� ; F@� [U:RDoc::Constant[i I"DUMMY_CONSTANT;TI"*RDoc::MarkupReference::DUMMY_CONSTANT;T; 0o;;[o; ;[I"Example constant.;T; @� ; 0@� @cRDoc::NormalClass0[ [[I" class;T[[; [[I"dummy_singleton_method;T@� [:protected[ [: private[ [I" instance;T[[; [ [I"args_directive;T@� [I"call_seq_directive;T@� [I"dummy_instance_alias;T@� [I"dummy_instance_method;T@� [I" method;T@� [I"yields_directive;T@� [;![ [;"[ [ [U:RDoc::Context::Section[i 0o;;[ ; 0; 0[@� @� cRDoc::TopLevel