Ruby 1.9.3 リファレンスマニュアル > ライブラリ一覧 > rdoc/includeライブラリ > RDoc::Includeクラス

class RDoc::Include + RDoc::CodeObject + RDoc::Text

クラスの継承リスト: RDoc::Include < RDoc::CodeObject < RDoc::Text < Object < Kernel < BasicObject

要約

includeされるファイルを表現します。

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

特異メソッド

new -> RDoc::CodeObject

自身を初期化します。

インスタンスメソッド

comment -> String

自身のコメントを返します。

comment=(comment)

自身のコメントを comment に設定します。

ただし、comment が空文字列だった場合は何もしません。

[PARAM] comment:
コメントを文字列で指定します。
document_children -> bool

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを返します。

[SEE_ALSO] RDoc::CodeObject#document_self

document_children=(val)

自身に含まれるメソッド、エイリアス、定数や属性をドキュメントに含めるか どうかを設定します。

:nodoc:、:stopdoc: を指定した時に false が設定されます。

[PARAM] val:
true を指定した場合、上記をドキュメントに含めます。

[SEE_ALSO] RDoc::CodeObject#document_self=, RDoc::CodeObject#remove_classes_and_modules

document_self -> bool

自身をドキュメントに含めるかどうかを返します。

[SEE_ALSO] RDoc::CodeObject#document_children

document_self=(val)

自身をドキュメントに含めるかどうかを設定します。

:doc: を指定した時に true が設定されます。 :nodoc:、:stopdoc: を指定した時に false が設定されます。

[PARAM] val:
true を指定した場合、自身をドキュメントに含めます。

[SEE_ALSO] RDoc::CodeObject#document_children=, RDoc::CodeObject#remove_methods_etc

documented? -> bool

出力すべきドキュメントがあるかどうかを返します。

expand_tabs(text) -> String

引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな るように置き換えます。

[PARAM] text:
文字列を指定します。
flush_left(text) -> String

引数から各行の行頭のスペースを削除します。

[PARAM] text:
文字列を指定します。
markup(text) -> String

引数を整形します。

include したクラスに self#formatter メソッドが必要です。

[PARAM] text:
文字列を指定します。
metadata -> Hash

自身が持つメタデータ(他から任意の値を設定してもよい)を返します。

normalize_comment(text) -> String

引数から行頭のスペースや改行文字などを削除します。

詳しくは [SEE ALSO] の各メソッドを参照してください。

[PARAM] text:
文字列を指定します。

[SEE_ALSO] RDoc::Text#strip_hashes, RDoc::Text#expand_tabs, RDoc::Text#flush_left, RDoc::Text#strip_newlines

parent -> RDoc::CodeObject

自身を所有する(変数や定数などの形で保持する)オブジェクトを返します。

parent=(val)

自身を所有する(変数や定数などの形で保持する)オブジェクトを設定します。

[PARAM] val:
RDoc::CodeObject のサブクラスのオブジェクトを指定しま す。
parent_file_name -> String

self.parent のファイル名を返します。

[SEE_ALSO] RDoc::CodeObject#parent

parent_name -> String

self.parent の名前を返します。

[SEE_ALSO] RDoc::CodeObject#parent

parse(text) -> RDoc::Markup::Document | Array

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。

[PARAM] text:
文字列を指定します。

[SEE_ALSO] RDoc::Text#normalize_comment

remove_classes_and_modules -> ()

何もしません。RDoc::CodeObject#document_children= に false を指定 した時のコールバックとして呼び出されます。オーバーライドして使用します。

remove_methods_etc -> ()

何もしません。RDoc::CodeObject#document_self= に false を指定した 時のコールバックとして呼び出されます。オーバーライドして使用します。

section -> RDoc::Context::Section

所属している section を返します。

section=(val)

所属する section を設定します。

[PARAM] val:
RDoc::Context::Section オブジェクトを指定します。
start_doc -> ()

以降に解析したコメントを RDoc::CodeObject#stop_doc を呼び出すまで の間、ドキュメントに含めます。

:startdoc: を見つけた時に呼び出されます。 RDoc::CodeObject#document_selfRDoc::CodeObject#document_children を true に設定します。

[SEE_ALSO] RDoc::CodeObject#end_doc

stop_doc -> ()

以降に解析したコメントを RDoc::CodeObject#start_doc を呼び出すま での間、ドキュメントに含めません。

:stopdoc: を見つけた時に呼び出されます。 RDoc::CodeObject#document_selfRDoc::CodeObject#document_children を false に設定します。

[SEE_ALSO] RDoc::CodeObject#start_doc

strip_hashes(text) -> String

引数から各行の行頭の # を削除します。

[PARAM] text:
文字列を指定します。
strip_newlines(text) -> String

引数から先頭と末尾の改行を削除します。

[PARAM] text:
文字列を指定します。
strip_stars(text) -> String

引数から /* 〜 */ 形式のコメントを削除します。

[PARAM] text:
文字列を指定します。
class RDoc::Include