class RDoc::Context::Section + RDoc::Text
クラスの継承リスト: RDoc::Context::Section < RDoc::Text < Object < Kernel < BasicObject
要約
section に関する情報を保持するクラスです。
ドキュメント中で以下のように記述した情報を保持しています。
# :section: The title # The body
特異メソッド
new(parent, title, comment) -> RDoc::Context::Section
-
自身を初期化します。
- [PARAM] parent:
- RDoc::Context オブジェクトを指定します。
- [PARAM] title:
- section のタイトルを文字列で指定します。
- [PARAM] comment:
- section のコメントを文字列で指定します。
また、section のシーケンス番号を新しく作成します。
インスタンスメソッド
self == other -> bool
-
自身と other のシーケンス番号を比較した結果を返します。
- [PARAM] other:
- RDoc::Context::Section オブジェクトを指定します。
comment -> String | nil
-
section のコメントを返します。
expand_tabs(text) -> String
-
引数中のタブ(\t)を直前の連続するスペースと合計して 8 文字のスペースにな るように置き換えます。
- [PARAM] text:
- 文字列を指定します。
flush_left(text) -> String
-
引数から各行の行頭のスペースを削除します。
- [PARAM] text:
- 文字列を指定します。
inspect -> String
-
自身の情報を人間に読みやすい文字列にして返します。
markup(text) -> String
-
引数を整形します。
include したクラスに self#formatter メソッドが必要です。
- [PARAM] text:
- 文字列を指定します。
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::Context
-
自身が所属する RDoc::Context オブジェクトを返します。
parse(text) -> RDoc::Markup::Document | Array
-
引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。
- [PARAM] text:
- 文字列を指定します。
[SEE_ALSO] RDoc::Text#normalize_comment
sequence -> String
-
section のシーケンス番号を文字列で返します。
リンクを作成する時に使われます。
set_comment(comment) -> ()
-
自身にコメントを設定します。
- [PARAM] comment:
- 文字列を指定します。
comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコ メントとして設定します。そうでない場合は comment すべてをコメントとして 設定します。
# --------------------- # :section: The title # The body # ---------------------
strip_hashes(text) -> String
-
引数から各行の行頭の # を削除します。
- [PARAM] text:
- 文字列を指定します。
strip_newlines(text) -> String
-
引数から先頭と末尾の改行を削除します。
- [PARAM] text:
- 文字列を指定します。
strip_stars(text) -> String
-
引数から /* 〜 */ 形式のコメントを削除します。
- [PARAM] text:
- 文字列を指定します。
title -> String | nil
-
section のタイトルを返します。