Ruby 2.5.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/parserライブラリ

library rdoc/parser

要約

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

以下のメソッドを定義したクラスを作成する事で、新しいパーサクラスを作成 する事ができます。

initialize メソッドは以下の引数を受け取ります。

scan メソッドは引数を受け取りません。処理の後は必ず RDoc::TopLevel オブジェクトを返す必要があります。

また、RDoc::Parser はファイル名からパーサクラスを取得するのにも使 われます。このために、新しく作成するパーサクラスでは RDoc::Parser を継承し、parse_files_matching メソッドで自身が解析できるファイル名のパ ターンを登録しておく必要があります。

例:

require "rdoc/parser"

class RDoc::Parser::Xyz < RDoc::Parser
  parse_files_matching /\.xyz$/

  def initialize(file_name, body, options)
    ...
  end

  def scan
    ...
  end
end

クラス

RDoc::Parser

ソースコードを解析するパーサを生成するための基本クラスです。

  RDoc::Parser::C

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析するためのクラスです。

  RDoc::Parser::ChangeLog

ChangeLog ファイルを解析するためのクラスです。

  RDoc::Parser::Markdown

Markdown 形式で記述されたファイルを解析するためのクラスです。

  RDoc::Parser::RD

RD 形式で記述されたファイルを解析するためのクラスです。

  RDoc::Parser::Ruby

Ruby のソースコードを解析するためのクラスです。

  RDoc::Parser::Simple

ソースコード以外のファイルを解析するためのクラスです。

RDoc::RubyLex

ライブラリの内部で使用します。

モジュール

RDoc::RubyToken

ライブラリの内部で使用します。

同時にrequireされるライブラリ

e2mmap

例外クラスに特定のエラーメッセージ用フォーマットを関連づけるためのライブラリです。

irb/notifier

ライブラリ内部で使用します。

irb/output-method

irb が出力を扱うためのサブライブラリです。

irb/slex

Ruby のソースコードを字句解析するためのサブライブラリです。 irb/ruby-lex から使用されます。

rdoc

RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。

rdoc/alias

RDoc::Alias を定義するサブライブラリです。

rdoc/anon_class

RDoc::AnonClass を定義するサブライブラリです。

rdoc/any_method

RDoc::AnyMethod を定義するサブライブラリです。

rdoc/attr

RDoc::Attr を定義するサブライブラリです。

rdoc/class_module

RDoc::ClassModule を定義するサブライブラリです。

rdoc/code_object

RDoc::CodeObject を定義するサブライブラリです。

rdoc/code_objects

Ruby のソースコード中にあるクラス、モジュール、メソッドなどの構成要素を 表現するためのサブライブラリです。

rdoc/constant

RDoc::Constant を定義するサブライブラリです。

rdoc/context

RDoc::ContextRDoc::Context::Section を定義するサブライ ブラリです。

rdoc/ghost_method

RDoc::GhostMethod を定義するサブライブラリです。

rdoc/include

RDoc::Include を定義するサブライブラリです。

rdoc/known_classes

Ruby の組み込みクラスに関する定数を定義するサブライブラリです。

rdoc/meta_method

RDoc::MetaMethod を定義するサブライブラリです。

rdoc/normal_class

RDoc::NormalClass を定義するサブライブラリです。

rdoc/normal_module

RDoc::NormalModule を定義するサブライブラリです。

rdoc/parser

rdoc で解析できるファイルの種類を追加するためのサブライブラリです。

rdoc/parser/c

C 言語で記述されたソースコードから組み込みクラス/モジュールのドキュメン トを解析するためのサブライブラリです。

rdoc/parser/changelog

ChangeLog ファイルを解析するためのサブライブラリです。

rdoc/parser/markdown

Markdown 形式で記述されたファイルを解析するためのサブライブラリです。

rdoc/parser/rd

RD 形式で記述されたファイルを解析するためのサブライブラリです。

rdoc/parser/ruby

Ruby のソースコードを解析するためのサブライブラリです。

rdoc/parser/simple

ソースコード以外のファイルを解析するためのサブライブラリです。

rdoc/require

RDoc::Require を定義するサブライブラリです。

rdoc/single_class

RDoc::SingleClass を定義するサブライブラリです。

rdoc/stats

RDoc のステータスを管理するサブライブラリです。

rdoc/token_stream

トークンを管理するためのサブライブラリです。

rdoc/top_level

RDoc::TopLevel を定義するサブライブラリです。

time

組み込みの Time クラスを拡張します。 日時を表す文字列をパースして Time オブジェクトに変換したり、 逆に Time オブジェクトを RFC などで定められた文字列に 変換する機能を提供します。

サブライブラリ

rdoc/parser/ruby_tools

RDoc::RubyLexRDoc::RubyToken を使って Ruby のソースコー ドのパーサを記述するためのモジュールを定義するサブライブラリです。

rdoc/parser/text

プログラムを含まないテキストを解析するためのサブライブラリです。