要約
section に関する情報を保持するクラスです。
ドキュメント中で以下のように記述した情報を保持しています。
# :section: The title # The body
目次
継承しているメソッド
- RDoc::Textから継承しているメソッド
特異メソッド
new(parent, title, comment) -> RDoc::Context::Section
[permalink][rdoc][edit]-
自身を初期化します。
- [PARAM] parent:
- RDoc::Context オブジェクトを指定します。
- [PARAM] title:
- section のタイトルを文字列で指定します。
- [PARAM] comment:
- section のコメントを文字列で指定します。
また、section のシーケンス番号を新しく作成します。
インスタンスメソッド
self == other -> bool
[permalink][rdoc][edit]-
自身と other のシーケンス番号を比較した結果を返します。
- [PARAM] other:
- RDoc::Context::Section オブジェクトを指定します。
comment -> String | nil
[permalink][rdoc][edit]-
section のコメントを返します。
inspect -> String
[permalink][rdoc][edit]-
自身の情報を人間に読みやすい文字列にして返します。
parent -> RDoc::Context
[permalink][rdoc][edit]-
自身が所属する RDoc::Context オブジェクトを返します。
sequence -> String
[permalink][rdoc][edit]-
section のシーケンス番号を文字列で返します。
リンクを作成する時に使われます。
set_comment(comment) -> ()
[permalink][rdoc][edit]-
自身にコメントを設定します。
- [PARAM] comment:
- 文字列を指定します。
comment の最初の行に :section: を含んでいた場合、その行以降の文字列をコメントとして設定します。そうでない場合は comment すべてをコメントとして設定します。
# --------------------- # :section: The title # The body # ---------------------
title -> String | nil
[permalink][rdoc][edit]-
section のタイトルを返します。