class RDoc::Context::Section

要約

section に関する情報を保持するクラスです。

ドキュメント中で以下のように記述した情報を保持しています。

# :section: The title
# The body

目次

特異メソッド

• new

インスタンスメソッド

• ==
• comment
• inspect
• sequence
• title

特異メソッド

new(title, comment) -> RDoc::Context::Section[permalink][rdoc]

自身を初期化します。

[PARAM] title:

section のタイトルを文字列で指定します。

[PARAM] comment:

section のコメントを文字列で指定します。

また、section のシーケンス番号を新しく作成します。

インスタンスメソッド

self == other -> bool[permalink][rdoc]

自身と other のシーケンス番号を比較した結果を返します。

[PARAM] other:

RDoc::Context::Section オブジェクトを指定します。

comment -> String | nil[permalink][rdoc]

section のコメントを返します。

inspect -> String[permalink][rdoc]

自身の情報を人間に読みやすい文字列にして返します。

sequence -> String[permalink][rdoc]

section のシーケンス番号を文字列で返します。

リンクを作成する時に使われます。

title -> String | nil[permalink][rdoc]

section のタイトルを返します。