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

library rdoc/parser/ruby

要約

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

拡張子が .rb、.rbw のファイルを解析する事ができます。

メタプログラミングされたメソッド

動的に定義されたメソッドをドキュメントに含めたい場合、## でコメントを開始します。

##
# This is a meta-programmed method!

add_my_method :meta_method, :arg1, :arg2

RDoc::Parser::Ruby は上記の :meta_method ようにメソッドの定義を行 うような識別子の後に続くトークンをメソッド名として解釈します。メソッド 名が見つからなかった場合、警告が表示されます。また、この場合はメソッド 名は 'unknown' になります。

:method: 命令を使う事でメソッド名を指定する事もできます。

##
# :method: woo_hoo!

デフォルトでは動的に定義されたメソッドはインスタンスメソッドとして解析 されます。特異メソッドとしたい場合は、:singleton-method: 命令を指定しま す。

##
# :singleton-method:

以下のようにメソッド名を指定する事もできます。

##
# :singleton-method: woo_hoo!

また、属性についても同様に :attr:、 :attr_reader:、 :attr_writer:、 :attr_accessor: を指定する事ができます。属性の名前は省略できます。

##
# :attr_reader: my_attr_name

隠しメソッド、属性

:method:、 :singleton-method: や :attr: 命令を使う事で実際には定義され ていないメソッドもドキュメントに含める事ができます。

##
# :attr_writer: ghost_writer
# There is an attribute here, but you can't see it!

##
# :method: ghost_method
# There is a method here, but you can't see it!

##
# this is a comment for a regular method

def regular_method() end

クラス

RDoc::Parser::Ruby

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

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 などで定められた文字列に 変換する機能を提供します。