Ruby 2.6.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/contextライブラリ > RDoc::Context::Sectionクラス

class RDoc::Context::Section

クラス・モジュールの継承リスト: RDoc::Context::Section < RDoc::Text < Object < Kernel < BasicObject

要約

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

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

# :section: The title
# The body

特異メソッド

定義 説明
new(parent, title, comment) -> RDoc::Context::Section

自身を初期化します。

インスタンスメソッド

定義 説明
self == other -> bool

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

comment -> String | nil

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

inspect -> String

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

parent -> RDoc::Context

自身が所属する RDoc::Context オブジェクトを返します。

sequence -> String

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

set_comment(comment) -> ()

自身にコメントを設定します。

title -> String | nil

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

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap then to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE expand_tabs flush_left markup normalize_comment parse strip_hashes strip_newlines strip_stars