要約
コメントテキストを処理するためのクラスです。
目次
- インスタンスメソッド
インスタンスメソッド
expand_tabs(text) -> String[permalink][rdoc][edit]-
引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースになるように置き換えます。
- [PARAM] text:
- 文字列を指定します。
flush_left(text) -> String[permalink][rdoc][edit]-
引数から各行の行頭のスペースを削除します。
- [PARAM] text:
- 文字列を指定します。
markup(text) -> String[permalink][rdoc][edit]-
引数を整形します。
include したクラスに self#formatter メソッドが必要です。
- [PARAM] text:
- 文字列を指定します。
normalize_comment(text) -> String[permalink][rdoc][edit]-
引数から行頭のスペースや改行文字などを削除します。
詳しくは [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][edit]-
引数から RDoc::Text#normalize_comment でスペースや改行文字などを削除した後に解析を行います。
- [PARAM] text:
- 文字列を指定します。
[SEE_ALSO] RDoc::Text#normalize_comment
strip_hashes(text) -> String[permalink][rdoc][edit]-
引数から各行の行頭の # を削除します。
- [PARAM] text:
- 文字列を指定します。
strip_newlines(text) -> String[permalink][rdoc][edit]-
引数から先頭と末尾の改行を削除します。
- [PARAM] text:
- 文字列を指定します。
strip_stars(text) -> String[permalink][rdoc][edit]-
引数から /* 〜 */ 形式のコメントを削除します。
- [PARAM] text:
- 文字列を指定します。