D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
proc
/
self
/
root
/
opt
/
alt
/
ruby34
/
share
/
ri
/
system
/
RDoc
/
TomDoc
/
Filename :
cdesc-TomDoc.ri
back
Copy
U:RDoc::NormalClass[iI"TomDoc:ETI"RDoc::TomDoc;TI"RDoc::Markup::Parser;To:RDoc::Markup::Document:@parts[o;;[o:RDoc::Markup::Paragraph;[I"?A parser for TomDoc based on TomDoc 1.0.0-rc1 (02adef9b5a);To:RDoc::Markup::BlankLine o; ;[I"@The TomDoc specification can be found at http://tomdoc.org.;T@o; ;[ I"QTo choose TomDoc as your only default format see RDoc::Options@Saved+Options;TI" ;TI"Nfor instructions on setting up a <code>.rdoc_options</code> file to store;T@I"your project default.;T@o; ;[ I"NThere are a few differences between this parser and the specification. A;T@I"Pbest-effort was made to follow the specification as closely as possible but;T@I"'some choices to deviate were made.;T@o; ;[ I"OA future version of RDoc will warn when a MUST or MUST NOT is violated and;T@I"Lmay warn when a SHOULD or SHOULD NOT is violated. RDoc will always try;T@I"8to emit documentation even if given invalid TomDoc.;T@o; ;[I"FHere are some implementation choices this parser currently makes:;T@o; ;[I"OThis parser allows rdoc-style inline markup but you should not depended on;T@I"it.;T@o; ;[I"HThis parser allows a space between the comment and the method body.;T@o; ;[I"JThis parser does not require the default value to be described for an;T@I"optional argument.;T@o; ;[I"QThis parser does not examine the order of sections. An Examples section may;T@I"#precede the Arguments section.;T@o; ;[I"PThis class is documented in TomDoc format. Since this is a subclass of the;T@I"DRDoc markup parser there isn't much to see here, unfortunately.;T: @fileI"lib/rdoc/tom_doc.rb;T:0@omit_headings_from_table_of_contents_below0;0;0[[ I"tokens;TI"R;T:publicFI"lib/rdoc/tom_doc.rb;T[ [ [[I" class;T[[; [[I"new;T@@[I" parse;T@@[I"signature;T@@[:protected[ [:private[ [I" instance;T[[; [ [I"build_heading;T@@[I"build_paragraph;T@@[I"build_verbatim;T@@[I" tokenize;T@@[;[ [;[ [ [U:RDoc::Context::Section[i 0o;;[ ;0;0U;[i I" Internal;To;;[ ;0;0U;[i I"Public;To;;[ ;0;0[@;@;cRDoc::TopLevel