Module: RDocF95

Defined in:

lib/rdoc-f95/template.rb,
lib/rdoc-f95.rb,
lib/rdoc-f95/dot.rb,
lib/rdoc-f95/usage.rb,
lib/rdoc-f95/diagram.rb,
lib/rdoc-f95/tokenstream.rb,
lib/rdoc-f95/code_objects.rb,
lib/rdoc-f95/parsers/parse_c.rb,
lib/rdoc-f95/parsers/parse_f95.rb,
lib/rdoc-f95/parsers/parserfactory.rb

Overview

An ERB wrapper.

This TemplatePage operates similarly to RDoc 1.x’s TemplatePage, but uses ERB instead of a custom template language.

Converting from a RDoc 1.x template to an RDoc 2.x template is fairly easy.

• %blah% becomes <%= values %>

• !INCLUDE! becomes <%= template_include %>

• HREF:aref:name becomes <%= href values, values %>

• IF:blah becomes <% if values then %>

• IFNOT:blah becomes <% unless values then %>

• ENDIF:blah becomes <% end %>

• START:blah becomes <% values.each do |blah| %>

• END:blah becomes <% end %>

To make nested loops easier to convert, start by converting START statements to:

<% values["blah"].each do |blah| $stderr.puts blah.keys %>

So you can see what is being used inside which loop.

Defined Under Namespace

Modules: DOT, Generator, ParserFactory, RI, TokenStream Classes: Alias, AnonClass, AnyMethod, Attr, C_Parser, ClassModule, CodeObject, Constant, Context, Diagram, Error, Fortran95parser, Include, Markup, NormalClass, NormalModule, Options, RDocF95, Require, RubyParser, SimpleParser, SingleClass, Stats, TemplatePage, Token, TopLevel

Constant Summary

VERSION =

RDoc version you are using

'0.0.2'

RDocError =

:nodoc:

Error

DOT_DOC_FILENAME =

".document"

GENERAL_MODIFIERS =

%w[nodoc].freeze

CLASS_MODIFIERS =

GENERAL_MODIFIERS

ATTR_MODIFIERS =

GENERAL_MODIFIERS

CONSTANT_MODIFIERS =

GENERAL_MODIFIERS

METHOD_MODIFIERS =

GENERAL_MODIFIERS +
%w[arg args yield yields notnew not-new not_new doc]

KNOWN_CLASSES =

Ruby’s built-in classes.

{
  "rb_cObject"           => "Object",
  "rb_cArray"            => "Array",
  "rb_cBignum"           => "Bignum",
  "rb_cClass"            => "Class",
  "rb_cDir"              => "Dir",
  "rb_cData"             => "Data",
  "rb_cFalseClass"       => "FalseClass",
  "rb_cFile"             => "File",
  "rb_cFixnum"           => "Fixnum",
  "rb_cFloat"            => "Float",
  "rb_cHash"             => "Hash",
  "rb_cInteger"          => "Integer",
  "rb_cIO"               => "IO",
  "rb_cModule"           => "Module",
  "rb_cNilClass"         => "NilClass",
  "rb_cNumeric"          => "Numeric",
  "rb_cProc"             => "Proc",
  "rb_cRange"            => "Range",
  "rb_cRegexp"           => "Regexp",
  "rb_cString"           => "String",
  "rb_cSymbol"           => "Symbol",
  "rb_cThread"           => "Thread",
  "rb_cTime"             => "Time",
  "rb_cTrueClass"        => "TrueClass",
  "rb_cStruct"           => "Struct",
  "rb_cVM"               => "VM",
  "rb_eException"        => "Exception",
  "rb_eStandardError"    => "StandardError",
  "rb_eSystemExit"       => "SystemExit",
  "rb_eInterrupt"        => "Interrupt",
  "rb_eSignal"           => "Signal",
  "rb_eFatal"            => "Fatal",
  "rb_eArgError"         => "ArgError",
  "rb_eEOFError"         => "EOFError",
  "rb_eIndexError"       => "IndexError",
  "rb_eRangeError"       => "RangeError",
  "rb_eIOError"          => "IOError",
  "rb_eRuntimeError"     => "RuntimeError",
  "rb_eSecurityError"    => "SecurityError",
  "rb_eSystemCallError"  => "SystemCallError",
  "rb_eTypeError"        => "TypeError",
  "rb_eZeroDivError"     => "ZeroDivError",
  "rb_eNotImpError"      => "NotImpError",
  "rb_eNoMemError"       => "NoMemError",
  "rb_eFloatDomainError" => "FloatDomainError",
  "rb_eScriptError"      => "ScriptError",
  "rb_eNameError"        => "NameError",
  "rb_eSyntaxError"      => "SyntaxError",
  "rb_eLoadError"        => "LoadError",

  "rb_mKernel"           => "Kernel",
  "rb_mComparable"       => "Comparable",
  "rb_mEnumerable"       => "Enumerable",
  "rb_mPrecision"        => "Precision",
  "rb_mErrno"            => "Errno",
  "rb_mFileTest"         => "FileTest",
  "rb_mGC"               => "GC",
  "rb_mMath"             => "Math",
  "rb_mProcess"          => "Process"
}