Ruby 2.5.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/textライブラリ > RDoc::Textモジュール

module RDoc::Text

クラスの継承リスト: RDoc::Text

要約

コメントテキストを処理するためのクラスです。

目次

インスタンスメソッド
expand_tabs flush_left markup normalize_comment parse strip_hashes strip_newlines strip_stars

インスタンスメソッド

expand_tabs(text) -> String[permalink][rdoc]

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

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

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

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

引数を整形します。

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

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

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

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

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

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

parse(text) -> RDoc::Markup::Document | Array[permalink][rdoc]

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

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

[SEE_ALSO] RDoc::Text#normalize_comment

strip_hashes(text) -> String[permalink][rdoc]

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

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

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

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

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

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